mcdev 6.0.1 → 7.0.0

package/lib/util/file.js

@@ -1,15 +1,34 @@
 /* eslint-disable no-control-regex */
 'use strict';
 
-import TYPE from '../../types/mcdev.d.js';
 import fs from 'fs-extra';
 
 import path from 'node:path';
 import prettier from 'prettier';
-import beautyAmp from 'beauty-amp-core';
+import beautyAmp from 'beauty-amp-core2';
 import { Util } from './util.js';
 import updateNotifier from 'update-notifier';
 
+/**
+ * @typedef {import('../../types/mcdev.d.js').AuthObject} AuthObject
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').Cache} Cache
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').DeltaPkgItem} DeltaPkgItem
+ * @typedef {import('../../types/mcdev.d.js').Mcdevrc} Mcdevrc
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').MultiMetadataTypeList} MultiMetadataTypeList
+ * @typedef {import('../../types/mcdev.d.js').MultiMetadataTypeMap} MultiMetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ * @typedef {import('../../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
+ */
+
 // inform user when there is an update
 const notifier = updateNotifier({
     pkg: Util.packageJsonMcdev,
@@ -22,17 +41,19 @@ notifier.notify();
  * File extends fs-extra. It adds logger and util methods for file handling
  */
 const File = {
+    prettierConfig: null,
+    prettierConfigFileType: null,
     /**
      * copies a file from one path to another
      *
      * @param {string} from - full filepath including name of existing file
      * @param {string} to - full filepath including name where file should go
-     * @returns {object} - results object
+     * @returns {Promise.<{status:'ok'|'skipped'|'failed', statusMessage:string, file:string}>} - results object
      */
     async copyFile(from, to) {
         try {
             await fs.copy(from, to);
-            return { status: 'ok', file: from };
+            return { status: 'ok', statusMessage: null, file: from };
         } catch (ex) {
             // This can happen in some cases where referencing files deleted in Commit
             return ex.message.startsWith('ENOENT: no such file or directory')
@@ -165,48 +186,52 @@ const File = {
      * @param {string} filename name of the file without suffix
      * @param {string} filetype filetype ie. JSON or SSJS
      * @param {string} content filecontent
-     * @param {TYPE.TemplateMap} [templateVariables] templating variables to be replaced in the metadata
+     * @param {TemplateMap} [templateVariables] templating variables to be replaced in the metadata
      * @returns {Promise.<boolean>} Promise
      */
     writePrettyToFile: async function (directory, filename, filetype, content, templateVariables) {
         let formatted =
             filetype === 'amp'
-                ? this._beautify_beautyAmp(content)
+                ? await this.beautify_beautyAmp(content, false)
                 : await this._beautify_prettier(directory, filename, filetype, content);
         if (templateVariables) {
             formatted = Util.replaceByObject(formatted, templateVariables);
         }
         return this.writeToFile(directory, filename, filetype, formatted);
     },
+    /**
+     * helper that applies beautyAmp onto given stringified content; strongly typed for strings only
+     *
+     * @param {string} content code
+     * @param {boolean} [formatHTML] applies formatting to html and ampscript if true
+     * @returns {Promise.<string>} formatted code
+     */
+    beautify_beautyAmp_beautify: async function (content, formatHTML = true) {
+        const response = await beautyAmp.beautify(content, formatHTML);
+        if (typeof response == 'string') {
+            return response.trim() + '\n';
+        } else {
+            throw new TypeError('beautyAmp failed to beautify the content');
+        }
+    },
     /**
      * helper for {@link File.writePrettyToFile}, applying beautyAmp onto given stringified content
      *
      * @param {string} content filecontent
-     * @returns {string} original string on error; formatted string on success
+     * @param {boolean} formatHTML should we format HTML or not via prettier included in beautyAmp
+     * @returns {Promise.<string>} original string on error; formatted string on success
      */
-    _beautify_beautyAmp: function (content) {
-        // immutable at the moment:
-        const ampscript = {
-            capitalizeAndOrNot: true,
-            capitalizeIfFor: true,
-            capitalizeSet: true,
-            capitalizeVar: true,
-            maxParametersPerLine: 4,
-        };
-        // immutable at the moment:
-        const editor = {
-            insertSpaces: true,
-            tabSize: 4,
-        };
+    beautify_beautyAmp: async function (content, formatHTML = true) {
         // logs trough console only for the moment.
         const logs = {
             loggerOn: false, // <= disable logging
         };
         try {
-            beautyAmp.setup(ampscript, editor, logs);
-            return beautyAmp.beautify(content);
+            beautyAmp.setup(null, null, logs);
+            // Note: we need to trim the result as beautyAmp adds a leading new line; but we also want to ensure there is a single new line at the end to comply with standard linting rules
+            return await this.beautify_beautyAmp_beautify(content, formatHTML);
         } catch (ex) {
-            Util.logger.debug('File._beautify_beautyAmp:: error | ' + ex.message);
+            Util.logger.debug('File.beautify_beautyAmp:: error | ' + ex.message);
             return content;
         }
     },
@@ -229,7 +254,7 @@ const File = {
             } else if (content.includes('%%[') || content.includes('%%=')) {
                 // in case we find AMPScript we need to abort beautifying as prettier
                 // will throw an error falsely assuming bad syntax
-                return this._beautify_beautyAmp(content);
+                return await this.beautify_beautyAmp(content, true);
             }
             // load the right prettier config relative to our file
             switch (filetype) {
@@ -345,11 +370,10 @@ const File = {
      *
      * @param {string | string[]} directory directory where the file is stored
      * @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)
+     * @param {boolean} cleanPath filters illegal chars if true
      * @returns {Promise.<object> | object | void} Promise or JSON object depending on if async or not; void on error
      */
-    readJSONFile: function (directory, filename, sync, cleanPath) {
+    readJSONFile: async function (directory, filename, cleanPath) {
         try {
             if (cleanPath == null || cleanPath == true) {
                 directory = this.filterIllegalPathChars(this.normalizePath(directory));
@@ -363,13 +387,9 @@ const File = {
             }
             let json;
             try {
-                json = sync
-                    ? fs.readJsonSync(path.join(directory, filename + '.json'))
-                    : fs.readJson(path.join(directory, filename + '.json'));
+                json = await fs.readJSON(path.join(directory, filename + '.json'));
             } catch (ex) {
-                // Note: this only works for sync, not async
                 Util.logger.debug(ex.stack);
-                throw new Error(`${ex.code}: ${ex.message}`);
             }
             return json;
         } catch (ex) {
@@ -383,16 +403,21 @@ const File = {
      * @param {string} filename name of the file without '.json' ending
      * @param {string} filetype filetype suffix
      * @param {string} [encoding] read file with encoding (defaults to utf-8)
-     * @returns {Promise.<string> | void} file contents; void on error
+     * @returns {Promise.<string>} file contents; void on error
      */
-    readFilteredFilename: function (directory, filename, filetype, encoding) {
+    readFilteredFilename: async function (directory, filename, filetype, encoding) {
         try {
             directory = this.filterIllegalPathChars(this.normalizePath(directory));
             filename = this.filterIllegalFilenames(filename);
-            return fs.readFile(path.join(directory, filename + '.' + filetype), encoding || 'utf8');
+            // @ts-expect-error - somehow, the declared type does not allow for encoding to be passed in as a string, despite that working and being stated in the docs.
+            return await fs.readFile(
+                path.join(directory, filename + '.' + filetype),
+                encoding || 'utf8'
+            );
         } catch (ex) {
-            Util.logger.error('File.readFilteredFilename:: error | ' + ex.message);
+            Util.logger.debug('File.readFilteredFilename:: error | ' + ex.message);
         }
+        return;
     },
     /**
      * reads directories to a specific depth returning an array
@@ -490,7 +515,9 @@ const File = {
                         includeStem,
                         _stemLength
                     );
-                    children.push(...nestedChildren);
+                    if (Array.isArray(nestedChildren) && nestedChildren.length > 0) {
+                        children.push(...nestedChildren);
+                    }
                 }
             }
             return children;
@@ -502,7 +529,7 @@ const File = {
     /**
      * helper that splits the config back into auth & config parts to save them separately
      *
-     * @param {TYPE.Mcdevrc} properties central properties object
+     * @param {Mcdevrc} properties central properties object
      * @returns {Promise.<void>} -
      */
     async saveConfigFile(properties) {
@@ -548,7 +575,5 @@ const File = {
     },
 };
 const FileFs = { ...fs, ...File };
-FileFs.prettierConfig = null;
-FileFs.prettierConfigFileType = null;
 
 export default FileFs;

package/lib/util/init.config.js

@@ -1,6 +1,5 @@
 'use strict';
 
-import TYPE from '../../types/mcdev.d.js';
 import Cli from './cli.js';
 import File from './file.js';
 import config from './config.js';
@@ -11,6 +10,26 @@ import semver from 'semver';
 import { fileURLToPath } from 'node:url';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
+/**
+ * @typedef {import('../../types/mcdev.d.js').AuthObject} AuthObject
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').Cache} Cache
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').DeltaPkgItem} DeltaPkgItem
+ * @typedef {import('../../types/mcdev.d.js').Mcdevrc} Mcdevrc
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').MultiMetadataTypeList} MultiMetadataTypeList
+ * @typedef {import('../../types/mcdev.d.js').MultiMetadataTypeMap} MultiMetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ * @typedef {import('../../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
+ */
+
 /**
  * CLI helper class
  */
@@ -19,7 +38,7 @@ const Init = {
     /**
      * helper method for this.upgradeProject that upgrades project config if needed
      *
-     * @param {TYPE.Mcdevrc} properties config file's json
+     * @param {Mcdevrc} properties config file's json
      * @returns {Promise.<boolean>} returns true if worked without errors
      */
     async fixMcdevConfig(properties) {
@@ -34,13 +53,16 @@ const Init = {
 
         const missingFields = await config.checkProperties(properties, true);
         const defaultProps = await config.getDefaultProperties();
-        if (missingFields.length) {
+        if (Array.isArray(missingFields) && missingFields.length) {
             for (const fieldName of missingFields) {
                 switch (fieldName) {
                     case 'marketList': {
+                        // @ts-expect-error - deprecated field
                         if (properties.marketBulk) {
                             upgradeMsgs.push(`- ✔️  converted 'marketBulk' to '${fieldName}'`);
+                            // @ts-expect-error - deprecated field
                             properties[fieldName] = properties.marketBulk;
+                            // @ts-expect-error - deprecated field
                             delete properties.marketBulk;
                         } else {
                             upgradeMsgs.push(`- ✔️  added '${fieldName}'`);
@@ -49,28 +71,35 @@ const Init = {
                         break;
                     }
                     case 'directories.docs': {
+                        // @ts-expect-error - deprecated field
                         if (properties.directories.badKeys) {
+                            // @ts-expect-error - deprecated field
                             delete properties.directories.badKeys;
                             upgradeMsgs.push(`- ✋ removed 'directories.badKeys'`);
                         }
+                        // @ts-expect-error - deprecated field
                         if (properties.directories.dataExtension) {
+                            // @ts-expect-error - deprecated field
                             File.removeSync(properties.directories.dataExtension);
+                            // @ts-expect-error - deprecated field
                             delete properties.directories.dataExtension;
                             upgradeMsgs.push(`- ✋ removed 'directories.dataExtension'`);
                         }
+                        // @ts-expect-error - deprecated field
                         if (properties.directories.deltaPackage) {
+                            // @ts-expect-error - deprecated field
                             delete properties.directories.deltaPackage;
                             upgradeMsgs.push(`- ✋ removed 'directories.deltaPackage'`);
                         }
-                        if (properties.directories.dataextension) {
-                            delete properties.directories.dataextension;
-                            upgradeMsgs.push(`- ✋ removed 'directories.dataextension'`);
-                        }
+                        // @ts-expect-error - deprecated field
                         if (properties.directories.roles) {
+                            // @ts-expect-error - deprecated field
                             delete properties.directories.roles;
                             upgradeMsgs.push(`- ✋ removed 'directories.roles'`);
                         }
+                        // @ts-expect-error - deprecated field
                         if (properties.directories.users) {
+                            // @ts-expect-error - deprecated field
                             delete properties.directories.users;
                             upgradeMsgs.push(`- ✋ removed 'directories.users'`);
                         }
@@ -237,22 +266,24 @@ const Init = {
         const boilerPlateFilesPath = path.resolve(__dirname, Util.boilerplateDirectory, 'files');
         // ! do not switch to readDirectories before merging the two custom methods. Their logic is different!
         const directories = await File.readDirectoriesSync(boilerPlateFilesPath, 10, false);
-        for (const subdir of directories) {
-            // walk thru the root of our boilerplate-files  directory and all sub folders
-            const curDir = path.join(boilerPlateFilesPath, subdir);
-            for (const file of await File.readdir(curDir)) {
-                // read all files in these directories
-                if (!(await File.lstat(path.join(curDir, file))).isDirectory()) {
-                    // filter entries that are actually folders
-                    const fileArr = file.split('.');
-                    const ext = '.' + fileArr.pop();
-                    // awaiting the result here due to interactive optional overwrite
-                    creationLog.push(
-                        await this._createIdeConfigFile(
-                            [subdir + path.sep, fileArr.join('.'), ext],
-                            relevantForcedUpdates
-                        )
-                    );
+        if (directories) {
+            for (const subdir of directories) {
+                // walk thru the root of our boilerplate-files  directory and all sub folders
+                const curDir = path.join(boilerPlateFilesPath, subdir);
+                for (const file of await File.readdir(curDir)) {
+                    // read all files in these directories
+                    if (!(await File.lstat(path.join(curDir, file))).isDirectory()) {
+                        // filter entries that are actually folders
+                        const fileArr = file.split('.');
+                        const ext = '.' + fileArr.pop();
+                        // awaiting the result here due to interactive optional overwrite
+                        creationLog.push(
+                            await this._createIdeConfigFile(
+                                [subdir + path.sep, fileArr.join('.'), ext],
+                                relevantForcedUpdates
+                            )
+                        );
+                    }
                 }
             }
         }
@@ -304,7 +335,7 @@ const Init = {
         let forceIdeConfigUpdate;
         const relevantForcedUpdates = [];
         if (await File.pathExists(Util.configFileName)) {
-            forceIdeConfigUpdate = File.readJsonSync(
+            forceIdeConfigUpdate = await File.readJSON(
                 path.resolve(__dirname, Util.boilerplateDirectory, 'forcedUpdates.json')
             );
             // return all if no project version was found or only changes from "newer" versions otherwise

package/lib/util/init.git.js

@@ -4,8 +4,8 @@ import File from './file.js';
 import inquirer from 'inquirer';
 import { Util } from './util.js';
 import commandExists from 'command-exists';
-import gitFactory from 'simple-git';
-const git = gitFactory();
+import { simpleGit } from 'simple-git';
+const git = simpleGit();
 
 /**
  * CLI helper class
@@ -36,7 +36,7 @@ const Init = {
             newRepoInitialized = false;
         } else {
             Util.logger.warn('No Git repository found. Initializing git:');
-            Util.execSync('git', ['init']);
+            Util.execSync('git', ['init', '--initial-branch=' + Util.defaultGitBranch]);
             if (await File.pathExists('.git')) {
                 newRepoInitialized = true;
             } else {
@@ -78,7 +78,7 @@ const Init = {
     /**
      * offer to push the new repo straight to the server
      *
-     * @returns {void}
+     * @returns {Promise.<void>} -
      */
     async gitPush() {
         const skipInteraction = Util.skipInteraction;
@@ -124,7 +124,7 @@ const Init = {
     /**
      * offers to add the git remote origin
      *
-     * @returns {string} repo name (optionally)
+     * @returns {Promise.<string>} repo name (optionally)
      */
     async _addGitRemote() {
         const skipInteraction = Util.skipInteraction;
@@ -178,7 +178,7 @@ const Init = {
     /**
      * checks global config and ask to config the user info and then store it locally
      *
-     * @returns {void}
+     * @returns {Promise.<void>} -
      */
     async _updateGitConfigUser() {
         const skipInteraction = Util.skipInteraction;

package/lib/util/init.js

@@ -1,5 +1,4 @@
 'use strict';
-import TYPE from '../../types/mcdev.d.js';
 import Cli from './cli.js';
 import File from './file.js';
 import config from './config.js';
@@ -11,6 +10,26 @@ import { Util } from './util.js';
 import fs from 'node:fs';
 import path from 'node:path';
 
+/**
+ * @typedef {import('../../types/mcdev.d.js').AuthObject} AuthObject
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').Cache} Cache
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').DeltaPkgItem} DeltaPkgItem
+ * @typedef {import('../../types/mcdev.d.js').Mcdevrc} Mcdevrc
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').MultiMetadataTypeList} MultiMetadataTypeList
+ * @typedef {import('../../types/mcdev.d.js').MultiMetadataTypeMap} MultiMetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ * @typedef {import('../../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
+ */
+
 /**
  * CLI helper class
  */
@@ -19,11 +38,12 @@ const Init = {
     /**
      * Creates template file for properties.json
      *
-     * @param {TYPE.Mcdevrc} properties config file's json
-     * @param {string} credentialName identifying name of the installed package / project
+     * @param {Mcdevrc} properties config file's json
+     * @param {string} [credentialName] identifying name of the installed package / project; if set, will update this credential
+     * @param {boolean} [refreshBUs] if this was triggered by mcdev join, do not refresh BUs
      * @returns {Promise.<void>} -
      */
-    async initProject(properties, credentialName) {
+    async initProject(properties, credentialName, refreshBUs = true) {
         if (!(await Init._checkPathForCloud())) {
             return;
         }
@@ -86,7 +106,11 @@ const Init = {
                     do {
                         error = false;
                         try {
-                            const success = await Cli.updateCredential(properties, badCredName);
+                            const success = await Cli.updateCredential(
+                                properties,
+                                badCredName,
+                                refreshBUs
+                            );
                             if (success) {
                                 Util.logger.info(`✔️  Credential '${badCredName}' updated.`);
                             } else {
@@ -156,14 +180,12 @@ const Init = {
 
             // set up IDE files and load npm dependencies
 
-            let status = await this.upgradeProject(properties, true, initGit.repoName);
-            if (!status) {
+            if (!(await this.upgradeProject(properties, true, initGit.repoName))) {
                 return;
             }
 
             // ask for credentials and create mcdev config
-            status = await Cli.initMcdevConfig();
-            if (!status) {
+            if (!(await Cli.initMcdevConfig())) {
                 return;
             }
 
@@ -266,7 +288,7 @@ const Init = {
             await InitGit._updateGitConfigUser();
 
             // ask the user to enter the server credentials
-            await this.initProject(properties);
+            await this.initProject(properties, null, false);
         } else {
             return;
         }
@@ -374,7 +396,7 @@ const Init = {
     /**
      * wrapper around npm dependency & configuration file setup
      *
-     * @param {TYPE.Mcdevrc} properties config file's json
+     * @param {Mcdevrc} properties config file's json
      * @param {boolean} [initial] print message if not part of initial setup
      * @param {string} [repoName] if git URL was provided earlier, the repo name was extracted to use it for npm init
      * @returns {Promise.<boolean>} success flag
@@ -397,7 +419,7 @@ const Init = {
                 return false;
             }
             // version 4 release to simplify auth
-            status = await InitConfig.upgradeAuthFile(properties);
+            status = await InitConfig.upgradeAuthFile();
             if (!status) {
                 return false;
             }
@@ -421,7 +443,7 @@ const Init = {
      * check if git repo is being saved on a cloud service and warn the user
      *
      * @private
-     * @returns {void} throws errors if problems were found
+     * @returns {Promise.<boolean>} true if path is good; false if project seems to be in a cloud service folder
      */
     async _checkPathForCloud() {
         const absolutePath = path.resolve('');
@@ -477,7 +499,7 @@ const Init = {
      * finds credentials that are set up in config but not in auth file
      *
      * @private
-     * @param {TYPE.Mcdevrc} properties javascript object in .mcdevrc.json
+     * @param {Mcdevrc} properties javascript object in .mcdevrc.json
      * @returns {string[]} list of credential names
      */
     _getMissingCredentials(properties) {

package/lib/util/init.npm.js

@@ -53,7 +53,7 @@ const Init = {
             // execute "no questions asked" npm init
             Util.execSync('npm', ['init', '--yes'], true);
             try {
-                fileContent = File.readFileSync('package.json', 'utf8');
+                fileContent = await File.readFile('package.json', 'utf8');
                 if (fileContent) {
                     projectPackageJson = JSON.parse(fileContent);
                 }
@@ -74,7 +74,7 @@ const Init = {
             Util.logger.debug(`Dependency file not found in ${dependencyFile}`);
             return false;
         }
-        const defaultDependencies = await File.readJson(dependencyFile);
+        const defaultDependencies = await File.readJSON(dependencyFile);
         const versionsDefault = {};
         for (const name of defaultDependencies) {
             // check mcdev.devDependencies first