mcdev 5.2.0 → 6.0.0

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,
@@ -83,6 +83,12 @@ module.exports = {
             retrieving: true,
             template: true,
         },
+        'subscriptions.r__dataExtension_CustomerKey': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
         'subscriptions.list': {
             isCreateable: true,
             isUpdateable: true,
@@ -127,7 +133,7 @@ module.exports = {
         },
         'options.createJourney': {
             isCreateable: true,
-            isUpdateable: true,
+            isUpdateable: false,
             retrieving: false,
             template: false,
         },
@@ -143,5 +149,17 @@ module.exports = {
             retrieving: true,
             template: true,
         },
+        r__asset_customerKey: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        r__journey_key: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
     },
 };

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

@@ -0,0 +1,88 @@
+export default {
+    bodyIteratorField: 'items',
+    dependencies: ['dataExtension'],
+    hasExtended: false,
+    idField: 'dataVerificationDefinitionId',
+    keyIsFixed: true,
+    keyField: 'dataVerificationDefinitionId',
+    createdDateField: null,
+    createdNameField: 'createdBy',
+    lastmodDateField: null,
+    lastmodNameField: null,
+    nameField: 'dataVerificationDefinitionId',
+    restPagination: false,
+    maxKeyLength: 36, // confirmed max length
+    type: 'verification',
+    typeDescription: 'Check DataExtension for a row count',
+    typeRetrieveByDefault: true,
+    typeName: 'Automation: Verification Activity',
+    fields: {
+        createdBy: {
+            // User ID
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        dataVerificationDefinitionId: {
+            isCreateable: false, // auto-assigned during creation by SFMC
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        notificationEmailAddress: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        notificationEmailMessage: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        shouldEmailOnFailure: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        shouldStopOnFailure: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        targetObjectId: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        value1: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        value2: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        verificationType: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        r__dataExtension_CustomerKey: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+    },
+};

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;

package/lib/util/file.js

@@ -1,18 +1,18 @@
 /* eslint-disable no-control-regex */
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const fs = require('fs-extra');
-const packageJson = require('../../package.json');
-const path = require('node:path');
-const prettier = require('prettier');
-const beautyAmp = require('beauty-amp-core');
-const Util = require('./util');
-const updateNotifier = require('update-notifier');
+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 { Util } from './util.js';
+import updateNotifier from 'update-notifier';
 
 // inform user when there is an update
 const notifier = updateNotifier({
-    pkg: packageJson,
+    pkg: Util.packageJsonMcdev,
     updateCheckInterval: 1000 * 3600 * 24, // once per day
 });
 // Notify using the built-in convenience method
@@ -218,9 +218,9 @@ const File = {
      * @param {string} filename name of the file without suffix
      * @param {string} filetype filetype ie. JSON or SSJS
      * @param {string} content filecontent
-     * @returns {string} original string on error; formatted string on success
+     * @returns {Promise.<string>} original string on error; formatted string on success
      */
-    _beautify_prettier: function (directory, filename, filetype, content) {
+    _beautify_prettier: async function (directory, filename, filetype, content) {
         let formatted = '';
         try {
             if (!FileFs.prettierConfig) {
@@ -275,13 +275,14 @@ const File = {
                 }
                 case 'sql': {
                     FileFs.prettierConfig.parser = 'sql';
+                    FileFs.prettierConfig.plugins = ['prettier-plugin-sql'];
                     break;
                 }
                 default: {
                     FileFs.prettierConfig.parser = 'babel';
                 }
             }
-            formatted = prettier.format(content, FileFs.prettierConfig);
+            formatted = await prettier.format(content, FileFs.prettierConfig);
         } catch (ex) {
             const warnMsg = `Potential Code issue found in ${this.normalizePath([
                 ...directory,
@@ -506,7 +507,7 @@ const File = {
      */
     async saveConfigFile(properties) {
         // we want to save to save the full version here to allow us to upgrade configs properly in the future
-        properties.version = packageJson.version;
+        properties.version = Util.packageJsonMcdev.version;
 
         await this.writeJSONToFile('', Util.configFileName.split('.json')[0], properties);
         Util.logger.info(`✔️  ${Util.configFileName} and ${Util.authFileName} saved successfully`);
@@ -550,4 +551,4 @@ const FileFs = { ...fs, ...File };
 FileFs.prettierConfig = null;
 FileFs.prettierConfigFileType = null;
 
-module.exports = FileFs;
+export default FileFs;

package/lib/util/init.config.js

@@ -1,13 +1,15 @@
 'use strict';
 
-const TYPE = require('../../types/mcdev.d');
-const Cli = require('./cli');
-const File = require('./file');
-const config = require('./config');
-const Util = require('./util');
-const inquirer = require('inquirer');
-const path = require('node:path');
-const semver = require('semver');
+import TYPE from '../../types/mcdev.d.js';
+import Cli from './cli.js';
+import File from './file.js';
+import config from './config.js';
+import { Util } from './util.js';
+import inquirer from 'inquirer';
+import path from 'node:path';
+import semver from 'semver';
+import { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 /**
  * CLI helper class
@@ -425,4 +427,4 @@ const Init = {
     },
 };
 
-module.exports = Init;
+export default Init;

package/lib/util/init.git.js

@@ -1,10 +1,11 @@
 'use strict';
-// const TYPE = require('../../types/mcdev.d');
-const File = require('./file');
-const inquirer = require('inquirer');
-const Util = require('./util');
-const commandExists = require('command-exists');
-const git = require('simple-git')();
+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();
 
 /**
  * CLI helper class
@@ -259,4 +260,4 @@ const Init = {
     },
 };
 
-module.exports = Init;
+export default Init;

package/lib/util/init.js

@@ -1,15 +1,15 @@
 'use strict';
-const TYPE = require('../../types/mcdev.d');
-const Cli = require('./cli');
-const File = require('./file');
-const config = require('./config');
-const InitGit = require('./init.git');
-const InitNpm = require('./init.npm');
-const InitConfig = require('./init.config');
-const inquirer = require('inquirer');
-const Util = require('./util');
-const fs = require('node:fs');
-const path = require('node:path');
+import TYPE from '../../types/mcdev.d.js';
+import Cli from './cli.js';
+import File from './file.js';
+import config from './config.js';
+import InitGit from './init.git.js';
+import InitNpm from './init.npm.js';
+import InitConfig from './init.config.js';
+import inquirer from 'inquirer';
+import { Util } from './util.js';
+import fs from 'node:fs';
+import path from 'node:path';
 
 /**
  * CLI helper class
@@ -506,4 +506,4 @@ const Init = {
     },
 };
 
-module.exports = Init;
+export default Init;