mcdev 3.1.1 → 4.0.0

package/lib/util/cli.js

@@ -1,10 +1,13 @@
 'use strict';
 
+const TYPE = require('../../types/mcdev.d');
 const BuHelper = require('./businessUnit');
 const File = require('./file');
+const config = require('./config');
 const inquirer = require('inquirer');
 const MetadataDefinitions = require('./../MetadataTypeDefinitions');
 const Util = require('./util');
+const auth = require('./auth');
 
 /**
  * CLI helper class
@@ -14,17 +17,14 @@ const Cli = {
     /**
      * used when initially setting up a project.
      * loads default config and adds first credential
-     * @param {Object} [skipInteraction] signals what to insert automatically for things usually asked via wizard
-     * @param {String} skipInteraction.clientId client id of installed package
-     * @param {String} skipInteraction.clientSecret client id of installed package
-     * @param {String} skipInteraction.tenant client id of installed package
-     * @param {String} skipInteraction.credentialsName how you would like the credential to be named
-     * @returns {Promise<boolean>} success of init
+     *
+     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     * @returns {Promise.<boolean>} success of init
      */
     async initMcdevConfig(skipInteraction) {
         Util.logger.info('-- Initialising server connection --');
         Util.logger.info('Please enter a name for your "Installed Package" credentials:');
-        const propertiesTemplate = Util.getDefaultProperties();
+        const propertiesTemplate = await config.getDefaultProperties();
         delete propertiesTemplate.credentials.default;
 
         // wait for the interaction to finish or else an outer await will run before this is done
@@ -32,17 +32,13 @@ const Cli = {
     },
     /**
      * Extends template file for properties.json
-     * @param {Object} properties config file's json
-     * @param {Object} properties.credentials list of existing credentials
-     * @param {Object} [skipInteraction] signals what to insert automatically for things usually asked via wizard
-     * @param {String} skipInteraction.clientId client id of installed package
-     * @param {String} skipInteraction.clientSecret client id of installed package
-     * @param {String} skipInteraction.tenant client id of installed package
-     * @param {String} skipInteraction.credentialsName how you would like the credential to be named
-     * @returns {Promise<void>} -
+     *
+     * @param {TYPE.Mcdevrc} properties config file's json
+     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     * @returns {Promise.<void>} -
      */
     async addExtraCredential(properties, skipInteraction) {
-        if (!Util.checkProperties(properties)) {
+        if (!(await config.checkProperties(properties))) {
             // return null here to avoid seeing 2 error messages for the same issue
             return null;
         } else {
@@ -53,9 +49,9 @@ const Cli = {
                 }
             }
             Util.logger.info('\nPlease enter your new credentials');
-            if (skipInteraction && properties.credentials[skipInteraction.credentialsName]) {
+            if (skipInteraction && properties.credentials[skipInteraction.credentialName]) {
                 Util.logger.error(
-                    `Credential '${skipInteraction.credentialsName}' already existing. If you tried updating please provide run 'mcdev init ${skipInteraction.credentialsName}'`
+                    `Credential '${skipInteraction.credentialName}' already existing. If you tried updating please provide run 'mcdev init ${skipInteraction.credentialName}'`
                 );
             }
             return this._setCredential(properties, null, skipInteraction);
@@ -64,14 +60,11 @@ const Cli = {
     /**
      * Extends template file for properties.json
      * update credentials
-     * @param {object} properties config file's json
+     *
+     * @param {TYPE.Mcdevrc} properties config file's json
      * @param {string} credName name of credential that needs updating
-     * @param {Object} [skipInteraction] signals what to insert automatically for things usually asked via wizard
-     * @param {String} skipInteraction.clientId client id of installed package
-     * @param {String} skipInteraction.clientSecret client id of installed package
-     * @param {String} skipInteraction.tenant client id of installed package
-     * @param {String} skipInteraction.credentialsName how you would like the credential to be named
-     * @returns {Promise<Boolean>} success of update
+     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     * @returns {Promise.<boolean>} success of update
      */
     async updateCredential(properties, credName, skipInteraction) {
         if (credName) {
@@ -83,15 +76,16 @@ const Cli = {
     },
     /**
      * Returns Object with parameters required for accessing API
-     * @param {Object} properties object of all configuration including credentials
-     * @param {String} target code of BU to use
+     *
+     * @param {TYPE.Mcdevrc} properties object of all configuration including credentials
+     * @param {string} target code of BU to use
      * @param {boolean|string} [isCredentialOnly] true:don't ask for BU | string: name of BU
      * @param {boolean} [allowAll] Offer ALL as option in BU selection
-     * @returns {Promise<Util.BuObject>} credential to be used for Business Unit
+     * @returns {Promise.<TYPE.BuObject>} credential to be used for Business Unit
      */
     async getCredentialObject(properties, target, isCredentialOnly, allowAll) {
         try {
-            if (!Util.checkProperties(properties)) {
+            if (!(await config.checkProperties(properties))) {
                 // return null here to avoid seeing 2 error messages for the same issue
                 return null;
             }
@@ -137,9 +131,6 @@ const Cli = {
                 );
             }
             return {
-                clientId: properties.credentials[credential].clientId,
-                clientSecret: properties.credentials[credential].clientSecret,
-                tenant: properties.credentials[credential].tenant,
                 eid: properties.credentials[credential].eid,
                 mid: properties.credentials[credential].businessUnits[businessUnit],
                 businessUnit: businessUnit,
@@ -153,11 +144,11 @@ const Cli = {
     /**
      * helps select the right credential in case of bad initial input
      *
-     * @param {object} properties config file's json
+     * @param {TYPE.Mcdevrc} properties config file's json
      * @param {string} [credential] name of valid credential
      * @param {boolean} [isCredentialOnly] don't ask for BU if true
      * @param {boolean} [allowAll] Offer ALL as option in BU selection
-     * @returns {Promise<Array>} selected credential/BU combo
+     * @returns {Promise.<Array>} selected credential/BU combo
      */
     async _selectBU(properties, credential, isCredentialOnly, allowAll) {
         const credList = [];
@@ -177,7 +168,7 @@ const Cli = {
                 name: 'credential',
                 message: 'Please select the credential you were looking for:',
                 choices: credList,
-                // eslint-disable-next-line require-jsdoc
+                // eslint-disable-next-line jsdoc/require-jsdoc
                 filter: function (answer) {
                     if (!isCredentialOnly) {
                         for (const bu in properties.credentials[answer].businessUnits) {
@@ -217,18 +208,9 @@ const Cli = {
         let responses = null;
         if (questions.length) {
             try {
-                responses = await new Promise((resolve) => {
-                    inquirer
-                        .prompt(questions)
-                        .then((answers) => {
-                            resolve(answers);
-                        })
-                        .catch((err) => {
-                            Util.logger.error(err);
-                        });
-                });
-            } catch (e) {
-                Util.logger.info(e);
+                responses = await inquirer.prompt(questions);
+            } catch (ex) {
+                Util.logger.info(ex);
             }
             if (responses.businessUnit && responses.businessUnit === allBUsAnswer) {
                 // remove textual explanation of *
@@ -242,15 +224,10 @@ const Cli = {
     /**
      * helper around _askCredentials
      *
-     * @param {object} properties from config file
+     * @param {TYPE.Mcdevrc} properties from config file
      * @param {string} [credName] name of credential that needs updating
-     * @param {Object} [skipInteraction] signals what to insert automatically for things usually asked via wizard
-     * @param {String} skipInteraction.clientId client id of installed package
-     * @param {String} skipInteraction.clientSecret client id of installed package
-     * @param {String} skipInteraction.tenant client id of installed package
-     * @param {String} skipInteraction.credentialsName how you would like the credential to be named
-     *
-     * @returns {Promise<boolean|String>} success of refresh or credential name
+     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     * @returns {Promise.<boolean | string>} success of refresh or credential name
      */
     async _setCredential(properties, credName, skipInteraction) {
         // Get user input
@@ -259,37 +236,40 @@ const Cli = {
         do {
             if (skipInteraction) {
                 if (
-                    skipInteraction.clientId &&
-                    skipInteraction.clientSecret &&
-                    skipInteraction.tenant &&
-                    skipInteraction.credentialsName
+                    skipInteraction.client_id &&
+                    skipInteraction.client_secret &&
+                    skipInteraction.auth_url &&
+                    skipInteraction.account_id &&
+                    skipInteraction.credentialName
                 ) {
-                    // assume skipInteraction=={clientId,clientSecret,tenant,credentialsName}
+                    // assume skipInteraction=={client_id,client_secret,auth_url,credentialName}
                     inputData = skipInteraction;
                 } else {
                     throw new Error(
-                        '--skipInteraction flag found but missing required input for clientId,clientSecret,tenant,credentialsName'
+                        '--skipInteraction flag found but missing required input for client_id,client_secret,auth_url,account_id,credentialName'
                     );
                 }
             } else {
                 inputData = await this._askCredentials(properties, credName);
             }
-            // Replace defaults with user input
-            const buObject = {
-                clientId: inputData.clientId,
-                clientSecret: inputData.clientSecret,
-                tenant: inputData.tenant,
-                eid: null,
-                businessUnits: null,
-            };
 
             // test if credentials are valid
             try {
-                await Util.getETClient(buObject);
+                await auth.saveCredential(
+                    {
+                        client_id: inputData.client_id,
+                        client_secret: inputData.client_secret,
+                        auth_url: inputData.auth_url,
+                        account_id: Number.parseInt(inputData.account_id),
+                    },
+                    inputData.credentialName
+                );
                 credentialsGood = true;
-
                 // update central config now that the credentials are verified
-                properties.credentials[inputData.credentialsName] = buObject;
+                properties.credentials[inputData.credentialName] = {
+                    eid: Number.parseInt(inputData.account_id),
+                    businessUnits: {},
+                };
             } catch (ex) {
                 Util.logger.error(ex.message);
                 credentialsGood = false;
@@ -300,25 +280,25 @@ const Cli = {
             }
         } while (!credentialsGood);
         // Get all business units and add them to the properties
-        const status = await BuHelper.refreshBUProperties(properties, inputData.credentialsName);
-        return status ? inputData.credentialsName : status;
+        const status = await BuHelper.refreshBUProperties(properties, inputData.credentialName);
+        return status ? inputData.credentialName : status;
     },
 
     /**
      * helper for addExtraCredential()
      *
-     * @param {Object} properties from config file
+     * @param {TYPE.Mcdevrc} properties from config file
      * @param {string} [credName] name of credential that needs updating
-     * @returns {Promise<Object>} credential info
+     * @returns {Promise.<object>} credential info
      */
     async _askCredentials(properties, credName) {
         const questions = [];
         if (!credName) {
             questions.push({
                 type: 'input',
-                name: 'credentialsName',
+                name: 'credentialName',
                 message: 'Credential name (your choice)',
-                // eslint-disable-next-line require-jsdoc
+                // eslint-disable-next-line jsdoc/require-jsdoc
                 validate: function (value) {
                     if (!value || value.trim().length < 2) {
                         return 'Please enter at least 2 characters';
@@ -334,13 +314,14 @@ const Cli = {
                 },
             });
         }
-        const tenantRegex = /^https:\/\/([\w-]*).(auth|soap|rest).marketingcloudapis.com[/]?$/iu;
+        const tenantRegex =
+            /^https:\/\/([\w-]{28})\.(auth|soap|rest)\.marketingcloudapis\.com[/]?$/iu;
         questions.push(
             {
                 type: 'input',
-                name: 'clientId',
+                name: 'client_id',
                 message: 'Client Id',
-                // eslint-disable-next-line require-jsdoc
+                // eslint-disable-next-line jsdoc/require-jsdoc
                 validate: function (value) {
                     if (!value || value.trim().length < 10) {
                         return 'Please enter valid client id';
@@ -350,9 +331,9 @@ const Cli = {
             },
             {
                 type: 'input',
-                name: 'clientSecret',
+                name: 'client_secret',
                 message: 'Client Secret',
-                // eslint-disable-next-line require-jsdoc
+                // eslint-disable-next-line jsdoc/require-jsdoc
                 validate: function (value) {
                     if (!value || value.trim().length < 10) {
                         return 'Please enter valid client secret';
@@ -362,7 +343,7 @@ const Cli = {
             },
             {
                 type: 'input',
-                name: 'tenant',
+                name: 'auth_url',
                 message: 'Authentication Base URI',
                 validate: (value) => {
                     if (!value || value.trim().length < 10) {
@@ -374,35 +355,32 @@ const Cli = {
                         return true;
                     }
                 },
+            },
+            {
+                type: 'number',
+                name: 'account_id',
+                message: 'MID of Parent Business Unit',
             }
         );
-        const responses = await new Promise((resolve) => {
-            inquirer.prompt(questions).then((answers) => {
-                resolve(answers);
-            });
-        });
+        const responses = await inquirer.prompt(questions);
         // remove extra white space
-        responses.clientId = responses.clientId.trim();
-        responses.clientSecret = responses.clientSecret.trim();
-        responses.tenant = responses.tenant.trim();
-
-        // extract the tenant sub-domain from the URI; the format was already validated above
-        responses.tenant = responses.tenant.match(tenantRegex)[1];
+        responses.client_id = responses.client_id.trim();
+        responses.client_secret = responses.client_secret.trim();
+        responses.auth_url = responses.auth_url.trim();
 
         if (credName) {
             // if credential name was provided as parameter, we didn't ask the user for it
-            responses.credentialsName = credName;
+            responses.credentialName = credName;
         }
 
         return responses;
     },
     /**
      * allows updating the metadata types that shall be retrieved
-     * @param {object} properties config file's json
-     * @param {object} properties.metaDataTypes -
-     * @param {String[]} properties.metaDataTypes.retrieve list of currently retrieved types
-     * @param {String[]} [setTypesArr] skip user prompt and overwrite with this list if given
-     * @returns {Promise<void>} -
+     *
+     * @param {TYPE.Mcdevrc} properties config file's json
+     * @param {string[]} [setTypesArr] skip user prompt and overwrite with this list if given
+     * @returns {Promise.<void>} -
      */
     async selectTypes(properties, setTypesArr) {
         let responses;
@@ -446,7 +424,7 @@ const Cli = {
                 name:
                     def.typeName +
                     (Util.logger.level === 'debug' && !def.typeRetrieveByDefault
-                        ? ' \x1b[1;30;40m(non-default)\u001b[0m'
+                        ? ' \x1B[1;30;40m(non-default)\u001B[0m'
                         : ''),
                 value: def.type,
                 disabled: !(Util.logger.level === 'debug' || def.typeRetrieveByDefault)
@@ -479,8 +457,7 @@ const Cli = {
             });
             // add end-of-list marker
             typeChoices.push(new inquirer.Separator(' ==== '));
-
-            const questions = [
+            responses = await inquirer.prompt([
                 {
                     type: 'checkbox',
                     message: 'Select Metadata types for retrieval',
@@ -488,12 +465,7 @@ const Cli = {
                     pageSize: 10,
                     choices: typeChoices,
                 },
-            ];
-            responses = await new Promise((resolve) => {
-                inquirer.prompt(questions).then((answers) => {
-                    resolve(answers);
-                });
-            });
+            ]);
         } else {
             responses = {
                 selectedTypes: setTypesArr,
@@ -510,9 +482,10 @@ const Cli = {
     /**
      * helper for this.selectTypes() that converts subtypes back to main type if all and only defaults were selected
      * this keeps the config automatically upgradable when we add new subtypes or change what is selected by default
-     * @param {Object} responses wrapper object for respones
-     * @param {String[]} responses.selectedTypes what types the user selected
-     * @param {String} type metadata type
+     *
+     * @param {object} responses wrapper object for respones
+     * @param {string[]} responses.selectedTypes what types the user selected
+     * @param {string} type metadata type
      * @returns {void}
      */
     _summarizeSubtypes(responses, type) {
@@ -541,7 +514,8 @@ const Cli = {
 
     /**
      * shows metadata type descriptions
-     * @returns {void} -
+     *
+     * @returns {void}
      */
     explainTypes() {
         // overwrites default layout of console.table
@@ -570,7 +544,7 @@ const Cli = {
                             (lastCountdown > 0 ? '├ ' : '└ ') +
                             (subTypeRetrieveByDefault ? 'yes' : '-'),
                         Description:
-                            definition.length > 90 ? definition.substr(0, 90) + '...' : definition,
+                            definition.length > 90 ? definition.slice(0, 90) + '...' : definition,
                     });
                 }
                 // change leading symbol of last subtype to close the tree visually
@@ -592,7 +566,7 @@ const Cli = {
             }
             return 0;
         });
-        console.table(typeChoices);
+        console.table(typeChoices); // eslint-disable-line no-console
     },
 };