mcdev 5.2.0 → 6.0.0

package/jsconfig.json

@@ -1,3 +1,7 @@
 {
-    "include": ["lib/**/*.js", "types/**/*.js"]
+    "include": ["lib/**/*.js", "types/**/*.js", "test/**/*.js"],
+    "compilerOptions": {
+        "module": "es6",
+        "target": "esnext"
+    }
 }

package/lib/Builder.js

@@ -1,12 +1,12 @@
 'use strict';
 
-const TYPE = require('../types/mcdev.d');
-const Util = require('./util/util');
-const File = require('./util/file');
-const config = require('./util/config');
-const Cli = require('./util/cli');
-const auth = require('./util/auth');
-const MetadataTypeInfo = require('./MetadataTypeInfo');
+import TYPE from '../types/mcdev.d.js';
+import { Util } from './util/util.js';
+import File from './util/file.js';
+import config from './util/config.js';
+import Cli from './util/cli.js';
+import auth from './util/auth.js';
+import MetadataTypeInfo from './MetadataTypeInfo.js';
 // @ts-ignore
 
 /**
@@ -249,4 +249,4 @@ saved
     }
 }
 
-module.exports = Builder;
+export default Builder;

package/lib/Deployer.js

@@ -1,14 +1,14 @@
 'use strict';
 
-const TYPE = require('../types/mcdev.d');
-const MetadataTypeInfo = require('./MetadataTypeInfo');
-const path = require('node:path');
-const Cli = require('./util/cli');
-const Util = require('./util/util');
-const File = require('./util/file');
-const config = require('./util/config');
-const cache = require('./util/cache');
-const auth = require('./util/auth');
+import TYPE from '../types/mcdev.d.js';
+import MetadataTypeInfo from './MetadataTypeInfo.js';
+import path from 'node:path';
+import Cli from './util/cli.js';
+import { Util } from './util/util.js';
+import File from './util/file.js';
+import config from './util/config.js';
+import cache from './util/cache.js';
+import auth from './util/auth.js';
 
 /**
  * Reads metadata from local directory and deploys it to specified target business unit.
@@ -455,4 +455,4 @@ class Deployer {
     }
 }
 
-module.exports = Deployer;
+export default Deployer;

package/lib/MetadataTypeDefinitions.js

@@ -1,43 +1,78 @@
 'use strict';
 
+import asset from './metadataTypes/definitions/Asset.definition.js';
+import attributeGroup from './metadataTypes/definitions/AttributeGroup.definition.js';
+import attributeSet from './metadataTypes/definitions/AttributeSet.definition.js';
+import automation from './metadataTypes/definitions/Automation.definition.js';
+import campaign from './metadataTypes/definitions/Campaign.definition.js';
+import contentArea from './metadataTypes/definitions/ContentArea.definition.js';
+import dataExtension from './metadataTypes/definitions/DataExtension.definition.js';
+import dataExtensionField from './metadataTypes/definitions/DataExtensionField.definition.js';
+import dataExtensionTemplate from './metadataTypes/definitions/DataExtensionTemplate.definition.js';
+import dataExtract from './metadataTypes/definitions/DataExtract.definition.js';
+import dataExtractType from './metadataTypes/definitions/DataExtractType.definition.js';
+import discovery from './metadataTypes/definitions/Discovery.definition.js';
+import email from './metadataTypes/definitions/Email.definition.js';
+import emailSend from './metadataTypes/definitions/EmailSend.definition.js';
+import event from './metadataTypes/definitions/Event.definition.js';
+import fileLocation from './metadataTypes/definitions/FileLocation.definition.js';
+import fileTransfer from './metadataTypes/definitions/FileTransfer.definition.js';
+import filter from './metadataTypes/definitions/Filter.definition.js';
+import folder from './metadataTypes/definitions/Folder.definition.js';
+import importFile from './metadataTypes/definitions/ImportFile.definition.js';
+import journey from './metadataTypes/definitions/Journey.definition.js';
+import list from './metadataTypes/definitions/List.definition.js';
+import mobileCode from './metadataTypes/definitions/MobileCode.definition.js';
+import mobileKeyword from './metadataTypes/definitions/MobileKeyword.definition.js';
+import mobileMessage from './metadataTypes/definitions/MobileMessage.definition.js';
+import query from './metadataTypes/definitions/Query.definition.js';
+import role from './metadataTypes/definitions/Role.definition.js';
+import script from './metadataTypes/definitions/Script.definition.js';
+import sendClassification from './metadataTypes/definitions/SendClassification.definition.js';
+import transactionalEmail from './metadataTypes/definitions/TransactionalEmail.definition.js';
+import transactionalPush from './metadataTypes/definitions/TransactionalPush.definition.js';
+import transactionalSMS from './metadataTypes/definitions/TransactionalSMS.definition.js';
+import triggeredSend from './metadataTypes/definitions/TriggeredSend.definition.js';
+import user from './metadataTypes/definitions/User.definition.js';
+import verification from './metadataTypes/definitions/Verification.definition.js';
+
 /**
- * Provides access to all metadataType classes
+ * Provides access to definitions of all metadataType classes
  */
-const MetadataTypeDefinitions = {
-    asset: require('./metadataTypes/definitions/Asset.definition'),
-    attributeGroup: require('./metadataTypes/definitions/AttributeGroup.definition'),
-    attributeSet: require('./metadataTypes/definitions/AttributeSet.definition'),
-    automation: require('./metadataTypes/definitions/Automation.definition'),
-    campaign: require('./metadataTypes/definitions/Campaign.definition'),
-    contentArea: require('./metadataTypes/definitions/ContentArea.definition'),
-    dataExtension: require('./metadataTypes/definitions/DataExtension.definition'),
-    dataExtensionField: require('./metadataTypes/definitions/DataExtensionField.definition'),
-    dataExtensionTemplate: require('./metadataTypes/definitions/DataExtensionTemplate.definition'),
-    dataExtract: require('./metadataTypes/definitions/DataExtract.definition'),
-    dataExtractType: require('./metadataTypes/definitions/DataExtractType.definition'),
-    discovery: require('./metadataTypes/definitions/Discovery.definition'),
-    email: require('./metadataTypes/definitions/Email.definition'),
-    emailSend: require('./metadataTypes/definitions/EmailSend.definition'),
-    event: require('./metadataTypes/definitions/Event.definition'),
-    fileLocation: require('./metadataTypes/definitions/FileLocation.definition'),
-    fileTransfer: require('./metadataTypes/definitions/FileTransfer.definition'),
-    filter: require('./metadataTypes/definitions/Filter.definition'),
-    folder: require('./metadataTypes/definitions/Folder.definition'),
-    importFile: require('./metadataTypes/definitions/ImportFile.definition'),
-    journey: require('./metadataTypes/definitions/Journey.definition'),
-    list: require('./metadataTypes/definitions/List.definition'),
-    mobileCode: require('./metadataTypes/definitions/MobileCode.definition'),
-    mobileKeyword: require('./metadataTypes/definitions/MobileKeyword.definition'),
-    mobileMessage: require('./metadataTypes/definitions/MobileMessage.definition'),
-    query: require('./metadataTypes/definitions/Query.definition'),
-    role: require('./metadataTypes/definitions/Role.definition'),
-    script: require('./metadataTypes/definitions/Script.definition'),
-    sendClassification: require('./metadataTypes/definitions/SendClassification.definition'),
-    transactionalEmail: require('./metadataTypes/definitions/TransactionalEmail.definition'),
-    transactionalPush: require('./metadataTypes/definitions/TransactionalPush.definition'),
-    transactionalSMS: require('./metadataTypes/definitions/TransactionalSMS.definition'),
-    triggeredSend: require('./metadataTypes/definitions/TriggeredSend.definition'),
-    user: require('./metadataTypes/definitions/User.definition'),
+export default {
+    asset,
+    attributeGroup,
+    attributeSet,
+    automation,
+    campaign,
+    contentArea,
+    dataExtension,
+    dataExtensionField,
+    dataExtensionTemplate,
+    dataExtract,
+    dataExtractType,
+    discovery,
+    email,
+    emailSend,
+    event,
+    fileLocation,
+    fileTransfer,
+    filter,
+    folder,
+    importFile,
+    journey,
+    list,
+    mobileCode,
+    mobileKeyword,
+    mobileMessage,
+    query,
+    role,
+    script,
+    sendClassification,
+    transactionalEmail,
+    transactionalPush,
+    transactionalSMS,
+    triggeredSend,
+    user,
+    verification,
 };
-
-module.exports = MetadataTypeDefinitions;

package/lib/MetadataTypeInfo.js

@@ -1,43 +1,78 @@
 'use strict';
 
+import asset from './metadataTypes/Asset.js';
+import attributeGroup from './metadataTypes/AttributeGroup.js';
+import attributeSet from './metadataTypes/AttributeSet.js';
+import automation from './metadataTypes/Automation.js';
+import campaign from './metadataTypes/Campaign.js';
+import contentArea from './metadataTypes/ContentArea.js';
+import dataExtension from './metadataTypes/DataExtension.js';
+import dataExtensionField from './metadataTypes/DataExtensionField.js';
+import dataExtensionTemplate from './metadataTypes/DataExtensionTemplate.js';
+import dataExtract from './metadataTypes/DataExtract.js';
+import dataExtractType from './metadataTypes/DataExtractType.js';
+import discovery from './metadataTypes/Discovery.js';
+import email from './metadataTypes/Email.js';
+import emailSend from './metadataTypes/EmailSend.js';
+import event from './metadataTypes/Event.js';
+import fileLocation from './metadataTypes/FileLocation.js';
+import fileTransfer from './metadataTypes/FileTransfer.js';
+import filter from './metadataTypes/Filter.js';
+import folder from './metadataTypes/Folder.js';
+import importFile from './metadataTypes/ImportFile.js';
+import journey from './metadataTypes/Journey.js';
+import list from './metadataTypes/List.js';
+import mobileCode from './metadataTypes/MobileCode.js';
+import mobileKeyword from './metadataTypes/MobileKeyword.js';
+import mobileMessage from './metadataTypes/MobileMessage.js';
+import query from './metadataTypes/Query.js';
+import role from './metadataTypes/Role.js';
+import script from './metadataTypes/Script.js';
+import sendClassification from './metadataTypes/SendClassification.js';
+import transactionalEmail from './metadataTypes/TransactionalEmail.js';
+import transactionalPush from './metadataTypes/TransactionalPush.js';
+import transactionalSMS from './metadataTypes/TransactionalSMS.js';
+import triggeredSend from './metadataTypes/TriggeredSend.js';
+import user from './metadataTypes/User.js';
+import verification from './metadataTypes/Verification.js';
+
 /**
  * Provides access to all metadataType classes
  */
-const MetadataTypeInfo = {
-    asset: require('./metadataTypes/Asset'),
-    attributeGroup: require('./metadataTypes/AttributeGroup'),
-    attributeSet: require('./metadataTypes/AttributeSet'),
-    automation: require('./metadataTypes/Automation'),
-    campaign: require('./metadataTypes/Campaign'),
-    contentArea: require('./metadataTypes/ContentArea'),
-    dataExtension: require('./metadataTypes/DataExtension'),
-    dataExtensionField: require('./metadataTypes/DataExtensionField'),
-    dataExtensionTemplate: require('./metadataTypes/DataExtensionTemplate'),
-    dataExtract: require('./metadataTypes/DataExtract'),
-    dataExtractType: require('./metadataTypes/DataExtractType'),
-    discovery: require('./metadataTypes/Discovery'),
-    email: require('./metadataTypes/Email'),
-    emailSend: require('./metadataTypes/EmailSend'),
-    event: require('./metadataTypes/Event'),
-    fileLocation: require('./metadataTypes/FileLocation'),
-    fileTransfer: require('./metadataTypes/FileTransfer'),
-    filter: require('./metadataTypes/Filter'),
-    folder: require('./metadataTypes/Folder'),
-    importFile: require('./metadataTypes/ImportFile'),
-    journey: require('./metadataTypes/Journey'),
-    list: require('./metadataTypes/List'),
-    mobileCode: require('./metadataTypes/MobileCode'),
-    mobileKeyword: require('./metadataTypes/MobileKeyword'),
-    mobileMessage: require('./metadataTypes/MobileMessage'),
-    query: require('./metadataTypes/Query'),
-    role: require('./metadataTypes/Role'),
-    script: require('./metadataTypes/Script'),
-    sendClassification: require('./metadataTypes/SendClassification'),
-    transactionalEmail: require('./metadataTypes/TransactionalEmail'),
-    transactionalPush: require('./metadataTypes/TransactionalPush'),
-    transactionalSMS: require('./metadataTypes/TransactionalSMS'),
-    triggeredSend: require('./metadataTypes/TriggeredSend'),
-    user: require('./metadataTypes/User'),
+export default {
+    asset,
+    attributeGroup,
+    attributeSet,
+    automation,
+    campaign,
+    contentArea,
+    dataExtension,
+    dataExtensionField,
+    dataExtensionTemplate,
+    dataExtract,
+    dataExtractType,
+    discovery,
+    email,
+    emailSend,
+    event,
+    fileLocation,
+    fileTransfer,
+    filter,
+    folder,
+    importFile,
+    journey,
+    list,
+    mobileCode,
+    mobileKeyword,
+    mobileMessage,
+    query,
+    role,
+    script,
+    sendClassification,
+    transactionalEmail,
+    transactionalPush,
+    transactionalSMS,
+    triggeredSend,
+    user,
+    verification,
 };
-
-module.exports = MetadataTypeInfo;

package/lib/Retriever.js

@@ -1,12 +1,12 @@
 'use strict';
 
-const TYPE = require('../types/mcdev.d');
-const MetadataTypeInfo = require('./MetadataTypeInfo');
-const MetadataDefinitions = require('./MetadataTypeDefinitions');
-const Util = require('./util/util');
-const File = require('./util/file');
-const cache = require('./util/cache');
-const auth = require('./util/auth');
+import TYPE from '../types/mcdev.d.js';
+import MetadataTypeInfo from './MetadataTypeInfo.js';
+import MetadataDefinitions from './MetadataTypeDefinitions.js';
+import { Util } from './util/util.js';
+import File from './util/file.js';
+import cache from './util/cache.js';
+import auth from './util/auth.js';
 /**
  * Retrieves metadata from a business unit and saves it to the local filesystem.
  */
@@ -210,4 +210,4 @@ class Retriever {
     }
 }
 
-module.exports = Retriever;
+export default Retriever;

package/lib/cli.js

@@ -1,15 +1,15 @@
 #!/usr/bin/env node
-'use strict';
 
 /**
  * CLI entry for SFMC DevTools
  */
 
-const Util = require('./util/util');
-const yargs = require('yargs');
-const Mcdev = require('./index');
+import { Util } from './util/util.js';
 
-yargs
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import Mcdev from './index.js';
+yargs(hideBin(process.argv))
     .scriptName('mcdev')
     .usage('$0 <command> [options]')
     .command({
@@ -45,7 +45,7 @@ yargs
         },
     })
     .command({
-        command: 'deploy [BU] [TYPE] [KEY] [--fromRetrieve] [--refresh]',
+        command: 'deploy [BU] [TYPE] [KEY]',
         aliases: ['d'],
         desc: 'deploys local metadata to a business unit',
         builder: (yargs) => {
@@ -97,6 +97,11 @@ yargs
                     group: 'Options for deploy:',
                     describe:
                         'optionally start existing schedule instead of running item once immediately (only works for automations)',
+                })
+                .option('fixShared', {
+                    group: 'Options for deploy:',
+                    describe:
+                        "optionally ensure that updates to shared DataExtensions become visible in child BU's data designer (SF Known issue W-11031095)",
                 });
         },
         handler: (argv) => {
@@ -595,7 +600,7 @@ yargs
     .demandCommand(1, 'Please enter a valid command')
     .strict()
     .recommendCommands()
-    .wrap(yargs.terminalWidth())
+    .wrap(yargs(hideBin(process.argv)).terminalWidth())
     .epilog(
         'Copyright 2023. Accenture. Get support at https://github.com/Accenture/sfmc-devtools/issues'
     )

package/lib/index.js

@@ -1,26 +1,33 @@
 'use strict';
 
-const TYPE = require('../types/mcdev.d');
-const Util = require('./util/util');
-const auth = require('./util/auth');
-const File = require('./util/file');
-const config = require('./util/config');
-const Init = require('./util/init');
-const InitGit = require('./util/init.git');
-const Cli = require('./util/cli');
-const DevOps = require('./util/devops');
-const BuHelper = require('./util/businessUnit');
-const Builder = require('./Builder');
-const Deployer = require('./Deployer');
-const MetadataTypeInfo = require('./MetadataTypeInfo');
-const MetadataTypeDefinitions = require('./MetadataTypeDefinitions');
-const Retriever = require('./Retriever');
-const cache = require('./util/cache');
+import TYPE from '../types/mcdev.d.js';
+import { Util } from './util/util.js';
+import auth from './util/auth.js';
+import File from './util/file.js';
+import config from './util/config.js';
+import Init from './util/init.js';
+import InitGit from './util/init.git.js';
+import Cli from './util/cli.js';
+import DevOps from './util/devops.js';
+import BuHelper from './util/businessUnit.js';
+import Builder from './Builder.js';
+import Deployer from './Deployer.js';
+import MetadataTypeInfo from './MetadataTypeInfo.js';
+import MetadataTypeDefinitions from './MetadataTypeDefinitions.js';
+import Retriever from './Retriever.js';
+import cache from './util/cache.js';
 
 /**
  * main class
  */
 class Mcdev {
+    /**
+     * @returns {string} current version of mcdev
+     */
+    static version() {
+        console.log('mcdev v' + Util.packageJsonMcdev.version); // eslint-disable-line no-console
+        return Util.packageJsonMcdev.version;
+    }
     /**
      * helper method to use unattended mode when including mcdev as a package
      *
@@ -56,12 +63,14 @@ class Mcdev {
             'commitHistory',
             'execute',
             'filter',
+            'fixShared',
             'fromRetrieve',
             'json',
             'like',
             'noLogColors',
             'noLogFile',
             'refresh',
+            '_runningTest',
             'schedule',
             'skipInteraction',
         ];
@@ -310,7 +319,8 @@ class Mcdev {
                 triggeredSend: 'triggeredSendDefinition',
                 user: 'accountUser',
             };
-            Util.logger.info(`:: Retrieving ${cred}/${bu}\n`);
+            Util.logger.info('');
+            Util.logger.info(`:: Retrieving ${cred}/${bu}`);
             const retrieveTypesArr = [];
             if (selectedTypesArr) {
                 for (const selectedType of Array.isArray(selectedTypesArr)
@@ -1155,4 +1165,4 @@ class Mcdev {
     }
 }
 
-module.exports = Mcdev;
+export default Mcdev;

package/lib/metadataTypes/Asset.js

@@ -1,12 +1,13 @@
 'use strict';
 
-const MetadataType = require('./MetadataType');
-const TYPE = require('../../types/mcdev.d');
-const Util = require('../util/util');
-const File = require('../util/file');
-const pLimit = require('p-limit');
-const cliProgress = require('cli-progress');
-const cache = require('../util/cache');
+import MetadataType from './MetadataType.js';
+import TYPE from '../../types/mcdev.d.js';
+import { Util } from '../util/util.js';
+import File from '../util/file.js';
+import pLimit from 'p-limit';
+import cliProgress from 'cli-progress';
+import cache from '../util/cache.js';
+import TriggeredSend from './TriggeredSend.js';
 
 /**
  * FileTransfer MetadataType
@@ -539,7 +540,6 @@ class Asset extends MetadataType {
             return;
         }
         // prep triggeredSendDefinition class
-        const TriggeredSend = require('./TriggeredSend');
         TriggeredSend.properties = this.properties;
         TriggeredSend.buObject = this.buObject;
         TriggeredSend.client = this.client;
@@ -1632,6 +1632,8 @@ class Asset extends MetadataType {
 }
 
 // Assign definition to static attributes
-Asset.definition = require('../MetadataTypeDefinitions').asset;
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
 
-module.exports = Asset;
+Asset.definition = MetadataTypeDefinitions.asset;
+
+export default Asset;

package/lib/metadataTypes/AttributeGroup.js

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