mcdev 5.3.0 → 6.0.0

package/lib/metadataTypes/TransactionalMessage.js

@@ -1,8 +1,8 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Util = require('../util/util');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
 
 /**
  * TransactionalMessage MetadataType
@@ -115,6 +115,7 @@ class TransactionalMessage extends MetadataType {
 
 // Assign definition to static attributes
 // ! using SMS definitions here as placeholder to have auto completion
-TransactionalMessage.definition = require('../MetadataTypeDefinitions').transactionalSMS;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+TransactionalMessage.definition = MetadataTypeDefinitions.transactionalSMS;
 
-module.exports = TransactionalMessage;
+export default TransactionalMessage;

package/lib/metadataTypes/TransactionalPush.js

@@ -1,9 +1,9 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const TransactionalMessage = require('./TransactionalMessage');
-const Util = require('../util/util');
-const cache = require('../util/cache');
+import TYPE from '../../types/mcdev.d.js';
+import TransactionalMessage from './TransactionalMessage.js';
+import { Util } from '../util/util.js';
+import cache from '../util/cache.js';
 
 /**
  * TransactionalPush TransactionalMessage
@@ -72,6 +72,7 @@ class TransactionalPush extends TransactionalMessage {
 }
 
 // Assign definition to static attributes
-TransactionalPush.definition = require('../MetadataTypeDefinitions').transactionalPush;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+TransactionalPush.definition = MetadataTypeDefinitions.transactionalPush;
 
-module.exports = TransactionalPush;
+export default TransactionalPush;

package/lib/metadataTypes/TransactionalSMS.js

@@ -1,11 +1,11 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const TransactionalMessage = require('./TransactionalMessage');
-const Util = require('../util/util');
-const File = require('../util/file');
-const beautifier = require('beauty-amp-core');
-const cache = require('../util/cache');
+import TYPE from '../../types/mcdev.d.js';
+import TransactionalMessage from './TransactionalMessage.js';
+import { Util } from '../util/util.js';
+import File from '../util/file.js';
+import beautifier from 'beauty-amp-core';
+import cache from '../util/cache.js';
 
 /**
  * TransactionalSMS MetadataType
@@ -341,6 +341,7 @@ class TransactionalSMS extends TransactionalMessage {
 }
 
 // Assign definition to static attributes
-TransactionalSMS.definition = require('../MetadataTypeDefinitions').transactionalSMS;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+TransactionalSMS.definition = MetadataTypeDefinitions.transactionalSMS;
 
-module.exports = TransactionalSMS;
+export default TransactionalSMS;

package/lib/metadataTypes/TriggeredSend.js

@@ -1,15 +1,12 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Util = require('../util/util');
-const cache = require('../util/cache');
-
-const cacheTypes = {
-    asset: require('./Asset'),
-    folder: require('./Folder'),
-    list: require('./List'),
-};
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
+import cache from '../util/cache.js';
+import asset from './Asset.js';
+import folder from './Folder.js';
+import list from './List.js';
 
 /**
  * MessageSendActivity MetadataType
@@ -273,6 +270,11 @@ class TriggeredSend extends MetadataType {
             asset: ['message'],
             list: null,
         };
+        const cacheTypes = {
+            asset,
+            folder,
+            list,
+        };
         for (const [type, subTypeArr] of Object.entries(requiredCache)) {
             if (type === 'asset' && assetLoaded) {
                 continue;
@@ -406,6 +408,7 @@ class TriggeredSend extends MetadataType {
 }
 
 // Assign definition to static attributes
-TriggeredSend.definition = require('../MetadataTypeDefinitions').triggeredSend;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+TriggeredSend.definition = MetadataTypeDefinitions.triggeredSend;
 
-module.exports = TriggeredSend;
+export default TriggeredSend;

package/lib/metadataTypes/User.js

@@ -1,10 +1,10 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Util = require('../util/util');
-const File = require('../util/file');
-const cache = require('../util/cache');
+import TYPE from '../../types/mcdev.d.js';
+import MetadataType from './MetadataType.js';
+import { Util } from '../util/util.js';
+import File from '../util/file.js';
+import cache from '../util/cache.js';
 
 /**
  * MetadataType
@@ -1169,6 +1169,7 @@ class User extends MetadataType {
 }
 
 // Assign definition to static attributes
-User.definition = require('../MetadataTypeDefinitions').user;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+User.definition = MetadataTypeDefinitions.user;
 
-module.exports = User;
+export default User;

package/lib/metadataTypes/Verification.js

@@ -1,11 +1,10 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const MetadataType = require('./MetadataType');
-const Automation = require('./Automation');
-const Util = require('../util/util');
-const cache = require('../util/cache');
-
+import Automation from './Automation.js';
+import MetadataType from './MetadataType.js';
+import TYPE from '../../types/mcdev.d.js';
+import { Util } from '../util/util.js';
+import cache from '../util/cache.js';
 /**
  * Verification MetadataType
  *
@@ -225,6 +224,7 @@ class Verification extends MetadataType {
 }
 
 // Assign definition to static attributes
-Verification.definition = require('../MetadataTypeDefinitions').verification;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+Verification.definition = MetadataTypeDefinitions.verification;
 
-module.exports = Verification;
+export default Verification;

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

@@ -1,5 +1,5 @@
 // asset types https://developer.salesforce.com/docs/atlas.en-us.noversion.mc-apis.meta/mc-apis/base-asset-types.htm
-module.exports = {
+export default {
     bodyIteratorField: 'items',
     dependencies: ['folder-asset', 'folder-asset-shared'],
     folderType: 'asset',

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'attributeGroupDefinitions',
     dependencies: ['attributeSet'], // future may have dependency on Data Extensions
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'setDefinition',
     dependencies: [
         'folder-hidden',

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     activityTypeMapping: {
         dataExtract: 73,
         dataFactoryUtility: 425,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'entry',
     dependencies: [],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: ['folder'],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: [
         'folder-hidden',

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: [],
     filter: {},

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: [],
     filter: {},

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'items',
     dependencies: ['dataExtension', 'dataExtractType'],
     hasExtended: true,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: [],
     dependencies: [],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: null,
     dependencies: [],
     endPointMapping: {

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: ['folder-hidden', 'folder-email', 'folder-shared_email_default'],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: ['folder-userinitiatedsends', 'email', 'asset-message', 'dataExtension', 'list'], // filter(+), sendClassification(+), SenderProfile(n/a), DeliveryProfile(n/a)
     folderType: 'userinitiatedsends',

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'items',
     dependencies: ['dataExtension'],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'items',
     dependencies: [],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'items',
     dependencies: ['fileLocation'],
     hasExtended: true,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'items',
     dependencies: [],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: [],
     subTypes: [

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'items',
     dependencies: ['fileLocation', 'dataExtension', 'list'],
     destinationObjectTypeMapping: {

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

@@ -2,7 +2,7 @@
 // obj definition: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/getting-started-spec.html
 // insert: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/postCreateInteraction.html
 // update: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/putUpdateInteraction.html
-module.exports = {
+export default {
     bodyIteratorField: 'items',
     dependencies: [
         'folder-journey',

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: ['folder-mysubs', 'folder-list', 'folder-publication'],
     folderType: 'list',

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'entry',
     dependencies: [],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'entry',
     dependencies: ['mobileCode'],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'entry',
     dependencies: ['mobileCode', 'mobileKeyword', 'campaign'],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'items',
     dependencies: ['folder-queryactivity', 'dataExtension'],
     folderType: 'queryactivity',

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: [],
     deployBlacklist: [

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'items',
     dependencies: ['folder-ssjsactivity'],
     folderType: 'ssjsactivity',

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

@@ -1,5 +1,5 @@
 // https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/sendclassification.html
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: [],
     filter: {},

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'definitions',
     dependencies: ['asset-message', 'dataExtension', 'list', 'journey'],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'definitions',
     dependencies: ['asset-asset'],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'definitions',
     dependencies: ['mobileCode', 'mobileKeyword'],
     hasExtended: false,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: [
         'folder-hidden',

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'Results',
     dependencies: ['role'],
     folderType: null,

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

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
     bodyIteratorField: 'items',
     dependencies: ['dataExtension'],
     hasExtended: false,

package/lib/retrieveChangelog.js

@@ -16,9 +16,10 @@
   }]
  */
 
-const mcdev = require('./index');
-const Definition = require('./MetadataTypeDefinitions');
-const MetadataType = require('./MetadataTypeInfo');
+import mcdev from './index.js';
+
+import Definition from './MetadataTypeDefinitions.js';
+import MetadataType from './MetadataTypeInfo.js';
 
 // disable cli logs
 // mcdev._setLoggingLevel({ silent: true });

package/lib/util/auth.js

@@ -1,10 +1,13 @@
-const TYPE = require('../../types/mcdev.d');
-const Util = require('./util');
-const File = require('./file');
-const SDK = require('sfmc-sdk');
-const Conf = require('conf');
-const credentialStore = new Conf({ configName: 'sessions', clearInvalidConfig: true });
-// const currentMID = null;
+import TYPE from '../../types/mcdev.d.js';
+import { Util } from './util.js';
+import File from './file.js';
+import SDK from 'sfmc-sdk';
+import Conf from 'conf';
+const credentialStore = new Conf({
+    projectName: 'mcdev',
+    configName: 'sessions',
+    clearInvalidConfig: true,
+});
 const initializedSDKs = {};
 let authfile;
 
@@ -159,4 +162,4 @@ function setupSDK(sessionKey, authObject) {
     });
 }
 
-module.exports = Auth;
+export default Auth;

package/lib/util/businessUnit.js

@@ -1,9 +1,9 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const Util = require('./util');
-const File = require('./file');
-const auth = require('./auth');
+import TYPE from '../../types/mcdev.d.js';
+import { Util } from './util.js';
+import File from './file.js';
+import auth from './auth.js';
 
 /**
  * Helper that handles retrieval of BU info
@@ -104,4 +104,4 @@ const BusinessUnit = {
     },
 };
 
-module.exports = BusinessUnit;
+export default BusinessUnit;

package/lib/util/cache.js

@@ -1,11 +1,11 @@
-const TYPE = require('../../types/mcdev.d');
-const Util = require('./util');
+import TYPE from '../../types/mcdev.d.js';
+import { Util } from './util.js';
 
 /** @type {TYPE.Cache} */
 const dataStore = {};
 let currentMID = null;
 
-module.exports = {
+export default {
     /**
      * Method to setup buObject
      * NOTE: in future this may need to restore, rather than wipe the cache

package/lib/util/cli.js

@@ -1,14 +1,16 @@
 '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');
-require('console.table');
+import TYPE from '../../types/mcdev.d.js';
+import BuHelper from './businessUnit.js';
+import File from './file.js';
+import config from './config.js';
+import inquirer from 'inquirer';
+import MetadataDefinitions from './../MetadataTypeDefinitions.js';
+import { Util } from './util.js';
+import auth from './auth.js';
+import 'console.table';
+import MetadataTypeInfo from './../MetadataTypeInfo.js';
+import TransactionalMessage from './../metadataTypes/TransactionalMessage.js';
 
 /**
  * CLI helper class
@@ -321,7 +323,9 @@ const Cli = {
                     businessUnits: {},
                 };
             } catch (ex) {
-                Util.logger.error(ex.message);
+                Util.logger.error(
+                    `We could not verify your credential due to a problem (${ex.message}). Please try again.`
+                );
                 credentialsGood = false;
                 if (skipInteraction) {
                     // break the otherwise infinite loop
@@ -570,8 +574,6 @@ const Cli = {
      * @returns {object[]} list of supported types with their apiNames
      */
     explainTypes() {
-        const MetadataTypeInfo = require('./../MetadataTypeInfo');
-        const TransactionalMessage = require('./../metadataTypes/TransactionalMessage');
         const json = [];
         const apiNameArr = Object.keys(MetadataDefinitions);
 
@@ -669,4 +671,4 @@ const Cli = {
     },
 };
 
-module.exports = Cli;
+export default Cli;

package/lib/util/config.js

@@ -1,9 +1,12 @@
-const TYPE = require('../../types/mcdev.d');
-const Util = require('./util');
-const File = require('./file');
-const inquirer = require('inquirer');
-const semver = require('semver');
-const path = require('node:path');
+import TYPE from '../../types/mcdev.d.js';
+import { Util } from './util.js';
+import File from './file.js';
+import inquirer from 'inquirer';
+import semver from 'semver';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
 /**
  * Central class for loading and validating properties from config and auth
  */
@@ -300,4 +303,4 @@ const config = {
         return defaultProperties;
     },
 };
-module.exports = config;
+export default config;

package/lib/util/devops.js

@@ -1,13 +1,14 @@
-const TYPE = require('../../types/mcdev.d');
-const File = require('./file');
-const path = require('node:path');
-const inquirer = require('inquirer');
-const Util = require('./util');
-const Cli = require('./cli');
-const git = require('simple-git')();
-const Builder = require('../Builder');
-const MetadataType = require('../MetadataTypeInfo');
-const jsonToTable = require('json-to-table');
+import TYPE from '../../types/mcdev.d.js';
+import File from './file.js';
+import path from 'node:path';
+import inquirer from 'inquirer';
+import { Util } from './util.js';
+import Cli from './cli.js';
+import gitFactory from 'simple-git';
+const git = gitFactory();
+import Builder from '../Builder.js';
+import MetadataType from '../MetadataTypeInfo.js';
+import jsonToTable from 'json-to-table';
 /**
  * DevOps helper class
  */
@@ -570,4 +571,4 @@ const DevOps = {
     },
 };
 
-module.exports = DevOps;
+export default DevOps;