mcdev 9.0.2 → 10.0.0

package/lib/cli.js

@@ -11,8 +11,6 @@ import { hideBin } from 'yargs/helpers';
 import Mcdev from './index.js';
 
 // use this instead of setting "true" directly to more easily find deprecated commands in this file
-const isDeprecated = true;
-
 /**
  * @typedef {import('../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
  */
@@ -53,18 +51,20 @@ yargs(hideBin(process.argv))
                 })
                 .option('skipValidation', {
                     alias: 'sv',
+                    type: 'boolean',
                     group: 'Options for retrieve:',
                     describe:
                         'allows reducing validation rules from error to warn to handle edge cases',
                 })
                 .option('fix', {
+                    type: 'boolean',
                     group: 'Options for retrieve:',
                     describe:
                         'should ONLY be used to identify what items would be filtered out or changed during build/deploy. This does not actually change anything on the server.',
                 })
                 .option('format', {
-                    type: 'boolean',
                     alias: 'f',
+                    type: 'boolean',
                     group: 'Options for retrieve:',
                     describe:
                         'allows overwriting options.formatOnSave from the config file. Disable formatting via --no-format',
@@ -117,8 +117,8 @@ yargs(hideBin(process.argv))
                         'type or type:key or type:i:id or type:n:name to deploy; if not provided, all metadata will be deploy',
                 })
                 .option('keySuffix', {
-                    type: 'string',
                     alias: 'ks',
+                    type: 'string',
                     group: 'Options for deploy:',
                     describe:
                         'allows you to add a suffix to the key of the metadata to be deployed',
@@ -130,101 +130,109 @@ yargs(hideBin(process.argv))
                         'for asset: enables the automatic addition of the MID to the key of the deployed metadata when deploying cross-BU. Alternatively, use --keySuffix or templating-based suffixes',
                 })
                 .option('changeKeyField', {
-                    type: 'string',
                     alias: 'ckf',
+                    type: 'string',
                     group: 'Options for deploy:',
                     describe:
                         'enables updating the key of the deployed metadata with the value in provided field (e.g. c__newKey). Can be used to sync name and key fields.',
                 })
                 .option('changeKeyValue', {
-                    type: 'string',
                     alias: 'ckv',
+                    type: 'string',
                     group: 'Options for deploy:',
                     describe:
                         'allows updating the key of the metadata to the provided value. Only available if a single type and key is deployed',
                 })
                 .option('fromRetrieve', {
-                    type: 'boolean',
                     alias: 'fr',
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe: 'deploy from retrieve folder',
                 })
                 .option('refresh', {
-                    type: 'boolean',
                     alias: 'r',
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe:
-                        'for asset-message: runs refresh command for related triggeredSends after deploy',
+                        'for asset-email: runs refresh command for related triggeredSends after deploy',
                 })
                 .option('execute', {
-                    type: 'boolean',
                     alias: 'e',
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe: 'executes item after deploy; this will run the item once immediately',
                 })
                 .option('schedule', {
-                    type: 'boolean',
                     alias: 's',
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe:
                         'start existing schedule instead of running item once immediately (only works for automations)',
                 })
                 .option('fixShared', {
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe:
                         "ensure that updates to shared DataExtensions become visible in child BU's data designer (SF Known issue W-11031095)",
                 })
                 .option('noUpdate', {
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe:
                         'if set, no metadata will be updated, only new metadata will be created',
                 })
                 .option('publish', {
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe: 'publishes the entity after deploy (only works on journeys)',
                 })
                 .option('validate', {
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe: 'validate the entity after deploy (only works on journeys)',
                 })
                 .option('skipStatusCheck', {
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe:
                         'only relevant if used together with --publish. if you do not care if publishing actually worked you can skip the checks with this option.',
                 })
                 .option('matchName', {
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe:
                         'Some metadata types allow updating resources despite a key mismatch by matching the name. That avoids clean-ups on all BUs but instead allows you to continously get higher environmetns into a better shape.',
                 })
                 .option('skipValidation', {
                     alias: 'sv',
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe:
                         'allows reducing validation rules from error to warn to handle edge cases',
                 })
                 .option('format', {
-                    type: 'boolean',
                     alias: 'f',
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe:
                         'allows overwriting options.formatOnSave from the config file. Disable formatting via --no-format',
                 })
                 .option('ignoreFolder', {
-                    type: 'boolean',
                     alias: 'if',
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe:
                         'works with --matchName and allows skipping folder match if there is only 1 name match',
                 })
                 .option('ignoreSfFields', {
-                    type: 'boolean',
                     alias: 'isf',
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe:
                         'relevant for Salesforce triggered journeys and events; allows ignoring errors on missing Salesforce fields in case the API returns other info than the GUI. CAUTION!',
                 })
                 .option('fix', {
+                    type: 'boolean',
                     group: 'Options for deploy:',
                     describe: 'auto-fix validation issues if the rule is able to do it',
                 }),
@@ -322,9 +330,9 @@ yargs(hideBin(process.argv))
                     describe: 'the key to delete',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for delete:',
                     describe: 'type or type:key or type:i:id or type:n:name to delete',
                 }),
@@ -369,78 +377,49 @@ yargs(hideBin(process.argv))
             Mcdev.resolveId(argv.BU, argv.TYPE, argv.ID);
         }
     )
-    .command(
-        ['retrieveAsTemplate <BU> <TYPE> <NAME> <MARKET>', 'rt'],
-        '[DEPRECATED] Retrieves a specific metadata file by name from the server for templating',
-        (yargs) =>
-            yargs
-                .positional('BU', {
-                    type: 'string',
-                    describe:
-                        'the business unit to deploy to (in format "credential name/BU name")',
-                })
-                .positional('TYPE', {
-                    type: 'string',
-                    describe: 'metadata type',
-                })
-                .positional('NAME', {
-                    type: 'string',
-                    describe: 'name of the metadata component',
-                })
-                .positional('MARKET', {
-                    type: 'string',
-                    describe: 'market used for reverse building template',
-                }),
-
-        (argv) => {
-            Mcdev.setOptions(argv);
-            Mcdev.retrieveAsTemplate(argv.BU, argv.TYPE, csvToArray(argv.NAME), argv.MARKET);
-        },
-        [],
-        isDeprecated
-    )
     .command(
         ['clone'],
         'clones items across BUs. Alias for: mcdev build --mf __clone__ --mt __clone__',
         (yargs) =>
             yargs
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Required parameters for clone:',
                     describe: 'type:key combos to clone',
                     demandOption: true,
                 })
                 .option('buFrom', {
-                    type: 'string',
                     alias: 'bf',
+                    type: 'string',
                     group: 'Required parameters for clone:',
                     describe:
                         'the business unit to create the templates from (in format "credential name/BU name")',
                     demandOption: true,
                 })
                 .option('buTo', {
-                    type: 'string',
                     alias: 'bt',
+                    type: 'string',
                     group: 'Required parameters for clone:',
                     describe: 'the business unit to deploy to; required unless --bulk is set',
                 })
                 .option('dependencies', {
-                    type: 'boolean',
                     alias: 'D',
+                    type: 'boolean',
                     group: 'Options for clone:',
                     describe: 'create templates for all dependencies of the metadata component',
                 })
                 .option('retrieve', {
-                    type: 'boolean',
                     alias: 'r',
+                    type: 'boolean',
                     group: 'Options for clone:',
                     describe:
                         're-retrieves potentially relevant metadata before running buildTemplate (all if --dependencies is used)',
                 })
                 .option('skipValidation', {
                     alias: 'sv',
+                    type: 'boolean',
                     group: 'Options for clone:',
                     describe:
                         'allows reducing validation rules from error to warn to handle edge cases',
@@ -464,39 +443,39 @@ yargs(hideBin(process.argv))
         (yargs) =>
             yargs
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Required parameters for build:',
                     describe: 'type:key combos to build template for',
                     demandOption: true,
                 })
                 .option('buFrom', {
-                    type: 'string',
                     alias: 'bf',
+                    type: 'string',
                     group: 'Required parameters for build:',
                     describe:
                         'the business unit to create the templates from (in format "credential name/BU name")',
                     demandOption: true,
                 })
                 .option('buTo', {
-                    type: 'string',
                     alias: 'bt',
+                    type: 'string',
                     group: 'Required parameters for build:',
                     describe: 'the business unit to deploy to; required unless --bulk is set',
                 })
                 .option('marketFrom', {
+                    alias: 'mf',
                     type: 'string',
                     array: true,
-                    alias: 'mf',
                     group: 'Required parameters for build:',
                     describe: 'market used for reverse building template',
                     demandOption: true,
                 })
                 .option('marketTo', {
+                    alias: 'mt',
                     type: 'string',
                     array: true,
-                    alias: 'mt',
                     group: 'Required parameters for build:',
                     describe: 'market used for building deployable definition',
                     demandOption: true,
@@ -514,8 +493,8 @@ yargs(hideBin(process.argv))
                     describe: 'create templates for all dependencies of the metadata component',
                 })
                 .option('retrieve', {
-                    type: 'boolean',
                     alias: 'r',
+                    type: 'boolean',
                     group: 'Options for build:',
                     describe:
                         're-retrieves potentially relevant metadata before running buildTemplate (all if --dependencies is used)',
@@ -534,6 +513,11 @@ yargs(hideBin(process.argv))
                 .option('fix', {
                     group: 'Options for build:',
                     describe: 'auto-fix validation issues if the rule is able to do it',
+                })
+                .option('shareAsset', {
+                    type: 'boolean',
+                    group: 'Options for build:',
+                    describe: 'share assets with corresponding business unit',
                 }),
         (argv) => {
             Mcdev.setOptions(argv);
@@ -573,9 +557,9 @@ yargs(hideBin(process.argv))
                     describe: 'market used for reverse building template',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for buildTemplate:',
                     describe: 'type:key combos to build template for',
                 })
@@ -586,18 +570,23 @@ yargs(hideBin(process.argv))
                     describe: 'market used for reverse building template',
                 })
                 .option('dependencies', {
-                    type: 'boolean',
                     alias: 'D',
+                    type: 'boolean',
                     group: 'Options for buildTemplate:',
                     describe: 'create templates for all dependencies of the metadata component',
                 })
                 .option('retrieve', {
-                    type: 'boolean',
                     alias: 'r',
+                    type: 'boolean',
                     group: 'Options for buildTemplate:',
                     describe:
                         're-retrieves potentially relevant metadata before building (all if --dependencies is used)',
                 })
+                .option('shareAsset', {
+                    type: 'boolean',
+                    group: 'Options for buildTemplate:',
+                    describe: 'share assets with corresponding business unit',
+                })
                 .check((argv) => {
                     if (!argv.MARKET && !argv.market) {
                         throw new Error(
@@ -648,9 +637,9 @@ yargs(hideBin(process.argv))
                     describe: 'market used for building deployable definition',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for buildDefinition:',
                     describe: 'type:templateName combos to build template for',
                 })
@@ -662,16 +651,19 @@ yargs(hideBin(process.argv))
                 })
                 .option('skipValidation', {
                     alias: 'sv',
+                    type: 'boolean',
                     group: 'Options for buildDefinition:',
                     describe:
                         'allows reducing validation rules from error to warn to handle edge cases',
                 })
                 .option('purge', {
+                    type: 'boolean',
                     group: 'Options for buildDefinition:',
                     describe:
                         'deletes the relevant deploy folder before building the definition. Add "--no-purge" to skip the question and not delete anything',
                 })
                 .option('fix', {
+                    type: 'boolean',
                     group: 'Options for buildDefinition:',
                     describe: 'auto-fix validation issues if the rule is able to do it',
                 })
@@ -721,24 +713,27 @@ yargs(hideBin(process.argv))
                     describe: 'File name of the metadata template without the extension',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for buildDefinitionBulk:',
                     describe: 'type:templateName combos to build template for',
                 })
                 .option('skipValidation', {
                     alias: 'sv',
+                    type: 'boolean',
                     group: 'Options for buildDefinitionBulk:',
                     describe:
                         'allows reducing validation rules from error to warn to handle edge cases',
                 })
                 .option('purge', {
+                    type: 'boolean',
                     group: 'Options for buildDefinitionBulk:',
                     describe:
                         'deletes the relevant deploy folder before building the definition. Add "--no-purge" to skip the question and not delete anything',
                 })
                 .option('fix', {
+                    type: 'boolean',
                     group: 'Options for buildDefinitionBulk:',
                     describe: 'auto-fix validation issues if the rule is able to do it',
                 }),
@@ -802,32 +797,40 @@ yargs(hideBin(process.argv))
                     describe: 'Number of commits to look back for changes (supersedes config)',
                 })
                 .option('dependencies', {
-                    type: 'boolean',
                     alias: 'D',
+                    type: 'boolean',
                     group: 'Options for build (run via createDeltaPkg):',
                     describe: 'create templates for all dependencies of the metadata component',
                 })
                 .option('retrieve', {
-                    type: 'boolean',
                     alias: 'r',
+                    type: 'boolean',
                     group: 'Options for build (run via createDeltaPkg):',
                     describe:
                         're-retrieves potentially relevant metadata before running buildTemplate (all if --dependencies is used)',
                 })
                 .option('skipValidation', {
                     alias: 'sv',
+                    type: 'boolean',
                     group: 'Options for build (run via createDeltaPkg):',
                     describe:
                         'allows reducing validation rules from error to warn to handle edge cases',
                 })
                 .option('purge', {
+                    type: 'boolean',
                     group: 'Options for build (run via createDeltaPkg):',
                     describe:
                         'deletes the relevant deploy folder before building the definition. Add "--no-purge" to skip the question and not delete anything',
                 })
                 .option('fix', {
+                    type: 'boolean',
                     group: 'Options for build (run via createDeltaPkg)',
                     describe: 'auto-fix validation issues if the rule is able to do it',
+                })
+                .option('shareAsset', {
+                    type: 'boolean',
+                    group: 'Options for build (run via createDeltaPkg):',
+                    describe: 'share assets with corresponding business unit',
                 }),
         (argv) => {
             Mcdev.setOptions(argv);
@@ -876,9 +879,9 @@ yargs(hideBin(process.argv))
                     describe: 'key(s) of the metadata component(s)',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for execute:',
                     describe: 'type or type:key or type:i:id or type:n:name to fix',
                 }),
@@ -910,9 +913,9 @@ yargs(hideBin(process.argv))
                     describe: 'key(s) of the metadata component(s)',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for execute:',
                     describe: 'type or type:key or type:i:id or type:n:name to fix',
                 })
@@ -964,9 +967,9 @@ yargs(hideBin(process.argv))
                     describe: 'key(s) of the metadata component(s)',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for publish:',
                     describe: 'type or type:key or type:i:id or type:n:name to fix',
                 })
@@ -977,6 +980,7 @@ yargs(hideBin(process.argv))
                         'filter metadata components (can include % as wildcard or _ for a single character)',
                 })
                 .option('skipStatusCheck', {
+                    type: 'boolean',
                     group: 'Options for publish:',
                     describe:
                         'if you don not care if publishing actually worked you can skip the checks',
@@ -1010,9 +1014,9 @@ yargs(hideBin(process.argv))
                     describe: 'key(s) of the metadata component(s)',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for validate:',
                     describe: 'type or type:key or type:i:id or type:n:name to fix',
                 })
@@ -1051,9 +1055,9 @@ yargs(hideBin(process.argv))
                     describe: 'key(s) of the metadata component(s)',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for schedule:',
                     describe: 'type or type:key or type:i:id or type:n:name to fix',
                 })
@@ -1099,9 +1103,9 @@ yargs(hideBin(process.argv))
                     describe: 'key(s) of the metadata component(s)',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for pause:',
                     describe: 'type or type:key or type:i:id or type:n:name to fix',
                 })
@@ -1147,9 +1151,9 @@ yargs(hideBin(process.argv))
                     describe: 'key(s) of the metadata component(s)',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for pause:',
                     describe: 'type or type:key or type:i:id or type:n:name to fix',
                 })
@@ -1187,9 +1191,9 @@ yargs(hideBin(process.argv))
                     describe: 'the business unit where to start an item',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for audit:',
                     describe: 'type or type:key or type:i:id or type:n:name to fix',
                     demandOption: true,
@@ -1224,9 +1228,9 @@ yargs(hideBin(process.argv))
                     describe: 'key(s) of the metadata component(s)',
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Options for fixKeys:',
                     describe: 'type or type:key or type:i:id or type:n:name to fix',
                 })
@@ -1237,22 +1241,22 @@ yargs(hideBin(process.argv))
                         'filter metadata components (can include % as wildcard or _ for a single character)',
                 })
                 .option('keySuffix', {
-                    type: 'string',
                     alias: 'ks',
+                    type: 'string',
                     group: 'Options for fixKeys:',
                     describe:
                         'allows you to add a suffix to the key of the metadata to be deployed.',
                 })
                 .option('execute', {
-                    type: 'boolean',
                     alias: 'e',
+                    type: 'boolean',
                     group: 'Options for fixKeys:',
                     describe:
                         'optional: executes item after deploy; this will run the item once immediately',
                 })
                 .option('schedule', {
-                    type: 'boolean',
                     alias: 's',
+                    type: 'boolean',
                     group: 'Options for fixKeys:',
                     describe:
                         'optionally start existing schedule instead of running item once immediately (only works for automations)',
@@ -1288,23 +1292,23 @@ yargs(hideBin(process.argv))
                     demandOption: true,
                 })
                 .option('to', {
-                    type: 'string',
                     alias: 't',
+                    type: 'string',
                     choices: ['key', 'name', 'id'],
                     group: 'Required parameters for replaceContentBlock:',
                     describe: 'what ampscript function to replace it with (key, name, id)',
                     demandOption: true,
                 })
                 .option('metadata', {
+                    alias: 'm',
                     type: 'string',
                     array: true,
-                    alias: 'm',
                     group: 'Optional parameters for replaceContentBlock:',
                     describe: 'type or type:key or type:i:id or type:n:name to fix',
                 })
                 .option('from', {
-                    type: 'string',
                     alias: 'f',
+                    type: 'string',
                     choices: ['key', 'name', 'id'],
                     array: true,
                     group: 'Optional parameters for replaceContentBlock:',
@@ -1312,8 +1316,8 @@ yargs(hideBin(process.argv))
                         'what ampscript function to search for (key, name, id); automatically set to values not used by --to if not provided',
                 })
                 .option('skipRetrieve', {
-                    type: 'boolean',
                     alias: 'sr',
+                    type: 'boolean',
                     group: 'Optional parameters for replaceContentBlock:',
                     describe:
                         'if you have already just downloaded the metadata and want to skip the retrieve step',
@@ -1325,11 +1329,11 @@ yargs(hideBin(process.argv))
                         'if you have want to carefully examine the changed files in your retrieve folder you can run this dry-run mode which skips the deploy step at the end',
                 })
                 .option('refresh', {
-                    type: 'boolean',
                     alias: 'r',
+                    type: 'boolean',
                     group: 'Optional parameters for replaceContentBlock:',
                     describe:
-                        'for asset-message: runs refresh command for related triggeredSends after deploy',
+                        'for asset-email: runs refresh command for related triggeredSends after deploy',
                 })
                 .check((argv) => {
                     if (argv.from) {
@@ -1371,6 +1375,20 @@ yargs(hideBin(process.argv))
             Mcdev.describeSoap(argv.TYPE, argv.bu);
         }
     )
+    .command(
+        ['migrate [BU]'],
+        'migrates historical asset groupings in one selected BU retrieve tree',
+        (yargs) =>
+            yargs.positional('BU', {
+                type: 'string',
+                describe:
+                    'the business unit to migrate (in format "credential name/BU name"); omit to select interactively; use "credential name/*" to migrate all BUs of that credential',
+            }),
+        (argv) => {
+            Mcdev.setOptions(argv);
+            Mcdev.migrate(argv.BU);
+        }
+    )
     .command(
         ['upgrade', 'up'],
         'Add NPM dependencies and IDE configuration files to your project',
@@ -1412,12 +1430,13 @@ yargs(hideBin(process.argv))
         type: 'boolean',
         description: 'Create a second log file that only contains error messages',
     })
+    .version(Util.packageJsonMcdev.version)
     .demandCommand(1, 'Please enter a valid command')
     .strict()
     .recommendCommands()
     .wrap(yargs(hideBin(process.argv)).terminalWidth())
     .epilog(
-        'Copyright 2025. Accenture. Get support at https://github.com/Accenture/sfmc-devtools/issues'
+        'Copyright 2026. Accenture. Get support at https://github.com/Accenture/sfmc-devtools/issues'
     )
     .help().argv;