mcdev 7.1.3 → 7.1.4

package/lib/metadataTypes/User.js

@@ -33,6 +33,7 @@ import cache from '../util/cache.js';
  */
 class User extends MetadataType {
     static userBUassignments;
+
     /**
      * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
      *
@@ -49,6 +50,7 @@ class User extends MetadataType {
         }
         return this._retrieve(retrieveDir, key);
     }
+
     /**
      * Retrieves import definition metadata for caching
      *
@@ -85,6 +87,7 @@ class User extends MetadataType {
         }
         return super.updateSOAP(metadata);
     }
+
     /**
      * prepares a item for deployment
      *
@@ -213,6 +216,7 @@ class User extends MetadataType {
 
         return metadata;
     }
+
     /**
      * helper for {@link MetadataType.upsert}
      *
@@ -307,6 +311,7 @@ class User extends MetadataType {
             await this._handleBuAssignments(upsertResults);
         }
     }
+
     /**
      * create/update business unit assignments
      *
@@ -574,6 +579,7 @@ class User extends MetadataType {
     static async retrieveChangelog() {
         return this._retrieve();
     }
+
     /**
      * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
      *
@@ -904,6 +910,7 @@ class User extends MetadataType {
         }
         return result + ' ' + interval;
     }
+
     /**
      * helper to print bu names
      *
@@ -929,6 +936,7 @@ class User extends MetadataType {
             }
         }
     }
+
     /**
      * helper for {@link User.createOrUpdate} to generate a random initial password for new users
      * note: possible minimum length values in SFMC are 6, 8, 10, 15 chars. Therefore we should default here to 15 chars.
@@ -957,6 +965,7 @@ class User extends MetadataType {
         );
         return retVal;
     }
+
     /**
      * Creates markdown documentation of all roles
      *
@@ -1100,6 +1109,7 @@ class User extends MetadataType {
             Util.logger.error(`user.document():: error | `, ex.message);
         }
     }
+
     /**
      *
      * @private

package/lib/metadataTypes/Verification.js

@@ -107,6 +107,7 @@ class Verification extends MetadataType {
             type: this.definition.type,
         };
     }
+
     /**
      * helper for {@link this.retrieveRESTcollection}
      *
@@ -208,6 +209,7 @@ class Verification extends MetadataType {
         delete metadata.r__dataExtension_key;
         return metadata;
     }
+
     /**
      * parses retrieved Metadata before saving
      *
@@ -230,6 +232,7 @@ class Verification extends MetadataType {
         }
         return metadata;
     }
+
     /**
      * Delete a metadata item from the specified business unit
      *

package/lib/retrieveChangelog.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 /* eslint-disable unicorn/prefer-top-level-await */
+
 /**
  * sample file on how to retrieve a simple changelog to use in GUIs or automated processing of any kind
  *

package/lib/util/auth.js

@@ -68,6 +68,7 @@ const Auth = {
             throw new Error(ex.message);
         }
     },
+
     /**
      * Returns an SDK instance to be used for API calls
      *
@@ -93,6 +94,7 @@ const Auth = {
             return initializedSDKs[credentialKey];
         }
     },
+
     /**
      * helper to clear all auth sessions
      *
@@ -103,6 +105,7 @@ const Auth = {
         Util.logger.info(`Auth sessions cleared`);
     },
 };
+
 /**
  * Returns an SDK instance to be used for API calls
  *

package/lib/util/cache.js

@@ -47,6 +47,7 @@ export default {
             throw new Error('Business Unit (buObject) used when initialzing cache was missing MID');
         }
     },
+
     /**
      * return entire cache for current MID
      *
@@ -55,6 +56,7 @@ export default {
     getCache: () => dataStore[currentMID],
 
     /* eslint-disable unicorn/no-array-for-each */
+
     /**
      * clean cache for one BU if mid provided, otherwise whole cache
      *
@@ -75,6 +77,7 @@ export default {
      * @returns {MetadataTypeItem} cached metadata item
      */
     getByKey: (type, key) => dataStore[currentMID]?.[type]?.[key],
+
     /**
      * override cache for given metadata type with new data
      *
@@ -85,6 +88,7 @@ export default {
     setMetadata: (type, metadataMap) => {
         dataStore[currentMID][type] = metadataMap;
     },
+
     /**
      * merges entire metadata type with existing cache
      *
@@ -104,6 +108,7 @@ export default {
         // merge metadataMap into existing cache
         Object.assign(dataStore[overrideMID || currentMID][type] || {}, metadataMap);
     },
+
     /**
      * standardized method for getting data from cache.
      *
@@ -147,6 +152,7 @@ export default {
             `Dependent ${metadataType} with ${searchField}='${searchValue}' was not found on your BU`
         );
     },
+
     /**
      * helper for setFolderId
      *
@@ -180,6 +186,7 @@ export default {
             throw new Error(`No folders found with path ${r__folder_Path}`);
         }
     },
+
     /**
      * standardized method for getting data from cache - adapted for special case of lists
      * ! keeping this in util/cache.js rather than in metadataTypes/List.js to avoid potential circular dependencies
@@ -217,6 +224,7 @@ export default {
             `Dependent list with ${searchField}='${searchValue}' was not found on your BU`
         );
     },
+
     /**
      * standardized method for getting data from cache - adapted for special case of lists
      * ! keeping this in util/cache.js rather than in metadataTypes/List.js to avoid potential circular dependencies

package/lib/util/cli.js

@@ -52,6 +52,7 @@ const Cli = {
         // wait for the interaction to finish or else an outer await will run before this is done
         return this._setCredential(propertiesTemplate, null);
     },
+
     /**
      * Extends template file for properties.json
      *
@@ -106,6 +107,7 @@ const Cli = {
             return fixKeysReretrieve;
         }
     },
+
     /**
      * helper that logs to cli which credentials are already existing in our config file
      *
@@ -120,6 +122,7 @@ const Cli = {
             }
         }
     },
+
     /**
      * Extends template file for properties.json
      * update credentials
@@ -138,6 +141,7 @@ const Cli = {
             return await this._setCredential(properties, credName, refreshBUs);
         }
     },
+
     /**
      * Returns Object with parameters required for accessing API
      *
@@ -217,6 +221,7 @@ const Cli = {
             return null;
         }
     },
+
     /**
      * helps select the right credential in case of bad initial input
      *
@@ -287,6 +292,7 @@ const Cli = {
         }
         return answer;
     },
+
     /**
      * helper around _askCredentials
      *
@@ -435,6 +441,7 @@ const Cli = {
 
         return responses;
     },
+
     /**
      * allows updating the metadata types that shall be retrieved
      *
@@ -537,6 +544,7 @@ const Cli = {
             await File.saveConfigFile(properties);
         }
     },
+
     /**
      * helper for {@link Cli.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

package/lib/util/config.js

@@ -97,6 +97,7 @@ const config = {
         }
         return config.properties;
     },
+
     /**
      * check if the config file is correctly formatted and has values
      *
@@ -292,6 +293,7 @@ const config = {
             }
         }
     },
+
     /**
      * defines how the properties.json should look like
      * used for creating a template and for checking if variables are set

package/lib/util/devops.js

@@ -358,6 +358,7 @@ const DevOps = {
         }
         return delta;
     },
+
     /**
      * wrapper around DevOps.getDeltaList, Builder.buildTemplate and M
      *
@@ -574,6 +575,7 @@ const DevOps = {
             Util.logger.error(`DevOps.document():: error | ` + ex.message);
         }
     },
+
     /**
      * should return only the json for all but asset, query and script that are saved as multiple files
      * additionally, the documentation for dataExtension and automation should be returned

package/lib/util/file.js

@@ -41,6 +41,7 @@ notifier.notify();
 const File = {
     prettierConfig: null,
     prettierConfigFileType: null,
+
     /**
      * copies a file from one path to another
      *
@@ -63,6 +64,7 @@ const File = {
                 : { status: 'failed', statusMessage: ex.message, file: from };
         }
     },
+
     /**
      * makes sure Windows accepts path names
      *
@@ -158,6 +160,7 @@ const File = {
         }
         /* eslint-enable unicorn/prefer-ternary */
     },
+
     /**
      * Saves json content to a file in the local file system. Will create the parent directory if it does not exist
      *
@@ -176,6 +179,7 @@ const File = {
             Util.logger.error('File.writeJSONToFile:: error | ' + ex.message);
         }
     },
+
     /**
      * Saves beautified files in the local file system. Will create the parent directory if it does not exist
      * ! Important: run 'await File.initPrettier()' in your MetadataType.retrieve() once before hitting this
@@ -197,6 +201,7 @@ const File = {
         }
         return this.writeToFile(directory, filename, filetype, formatted);
     },
+
     /**
      * helper that applies beautyAmp onto given stringified content; strongly typed for strings only
      *
@@ -212,6 +217,7 @@ const File = {
             throw new TypeError('beautyAmp failed to beautify the content');
         }
     },
+
     /**
      * helper for {@link File.writePrettyToFile}, applying beautyAmp onto given stringified content
      *
@@ -232,6 +238,7 @@ const File = {
             return content;
         }
     },
+
     /**
      * helper for {@link File.writePrettyToFile}, applying prettier onto given stringified content
      * ! Important: run 'await File.initPrettier()' in your MetadataType.retrieve() once before hitting this
@@ -326,6 +333,7 @@ const File = {
 
         return formatted;
     },
+
     /**
      * Saves text content to a file in the local file system. Will create the parent directory if it does not exist
      *
@@ -385,6 +393,7 @@ const File = {
             Util.logger.error('File.readJSONFile:: error | ' + ex.message);
         }
     },
+
     /**
      * reads file from local file system.
      *
@@ -405,6 +414,7 @@ const File = {
         }
         return;
     },
+
     /**
      * reads directories to a specific depth returning an array
      * of file paths to be iterated over
@@ -512,6 +522,7 @@ const File = {
             Util.logger.debug(ex.stack);
         }
     },
+
     /**
      * helper that splits the config back into auth & config parts to save them separately
      *
@@ -525,6 +536,7 @@ const File = {
         await this.writeJSONToFile('', Util.configFileName.split('.json')[0], properties);
         Util.logger.info(`✔️  ${Util.configFileName} and ${Util.authFileName} saved successfully`);
     },
+
     /**
      * Initalises Prettier formatting lib async.
      *

package/lib/util/init.config.js

@@ -301,6 +301,7 @@ const Init = {
             return true;
         }
     },
+
     /**
      * recursive helper for {@link Init.fixMcdevConfig} that adds missing settings
      *
@@ -326,6 +327,7 @@ const Init = {
             propertiersCur[fieldName] = defaultPropsCur[fieldName];
         }
     },
+
     /**
      * returns list of files that need to be updated
      *
@@ -362,6 +364,7 @@ const Init = {
 
         return { updates, deletes };
     },
+
     /**
      * handles creation/update of one config file from the boilerplate at a time
      *
@@ -451,6 +454,7 @@ const Init = {
             return true;
         }
     },
+
     /**
      * handles deletion of no longer needed config files
      *
@@ -470,6 +474,7 @@ const Init = {
         }
         return true;
     },
+
     /**
      * helper method for this.upgradeProject that upgrades project config if needed
      *

package/lib/util/init.git.js

@@ -75,6 +75,7 @@ const Init = {
         result.status = newRepoInitialized ? 'init' : 'update';
         return result;
     },
+
     /**
      * offer to push the new repo straight to the server
      *
@@ -117,6 +118,7 @@ const Init = {
             }
         }
     },
+
     /**
      * offers to add the git remote origin
      *
@@ -164,6 +166,7 @@ const Init = {
             }
         }
     },
+
     /**
      * checks global config and ask to config the user info and then store it locally
      *
@@ -233,6 +236,7 @@ const Init = {
             }
         }
     },
+
     /**
      * retrieves the global user.name and user.email values
      *

package/lib/util/init.js

@@ -282,6 +282,7 @@ const Init = {
             return;
         }
     },
+
     /**
      * helper for @initProject that optionally creates markets and market lists for all BUs
      */
@@ -337,6 +338,7 @@ const Init = {
         }
         await File.saveConfigFile(properties);
     },
+
     /**
      * helper for {@link Init.initProject}
      *
@@ -373,6 +375,7 @@ const Init = {
             }
         }
     },
+
     /**
      * wrapper around npm dependency & configuration file setup
      *
@@ -419,6 +422,7 @@ const Init = {
 
         return true;
     },
+
     /**
      * check if git repo is being saved on a cloud service and warn the user
      *

package/lib/util/init.npm.js

@@ -127,6 +127,7 @@ const Init = {
         }
         return true;
     },
+
     /**
      * ensure we have certain default values in our config
      *

package/lib/util/replaceContentBlockReference.js

@@ -149,6 +149,7 @@ export default class ReplaceContentBlockReference {
         }
         return result;
     }
+
     /**
      *
      * @param {ContentBlockConversionTypes} from replace with