mcdev 7.0.4 → 7.1.1

package/lib/cli.js

@@ -38,6 +38,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('metadata', {
                     type: 'string',
+                    array: true,
                     alias: 'm',
                     group: 'Options for retrieve:',
                     describe:
@@ -79,6 +80,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('metadata', {
                     type: 'string',
+                    array: true,
                     alias: 'm',
                     group: 'Options for deploy:',
                     describe:
@@ -91,11 +93,11 @@ yargs(hideBin(process.argv))
                     describe:
                         'allows you to add a suffix to the key of the metadata to be deployed',
                 })
-                .option('noMidSuffix', {
+                .option('autoMidSuffix', {
                     type: 'boolean',
                     group: 'Options for deploy:',
                     describe:
-                        'for asset: disables the automatic addition of the MID to the key of the deployed metadata when deploying cross-BU. Should be used with --keySuffix or with templating-based suffixes',
+                        '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',
@@ -141,6 +143,20 @@ yargs(hideBin(process.argv))
                     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', {
+                    group: 'Options for deploy:',
+                    describe:
+                        'if set, no metadata will be updated, only new metadata will be created',
+                })
+                .option('publish', {
+                    group: 'Options for deploy:',
+                    describe: 'publishes the entity after deploy (only works on journeys)',
+                })
+                .option('skipStatusCheck', {
+                    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.',
                 }),
         (argv) => {
             Mcdev.setOptions(argv);
@@ -236,6 +252,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('metadata', {
                     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',
@@ -318,6 +335,7 @@ yargs(hideBin(process.argv))
             yargs
                 .option('metadata', {
                     type: 'string',
+                    array: true,
                     alias: 'm',
                     group: 'Required parameters for build:',
                     describe: 'type:key combos to build template for',
@@ -353,10 +371,22 @@ yargs(hideBin(process.argv))
                 })
                 .option('bulk', {
                     type: 'boolean',
-                    group: 'Optional parameters for build:',
+                    group: 'Options for build:',
                     describe:
                         'if defined, the marketTo parameter has to be a marketList and buildDefinitionBulk is executed',
-                    demandOption: true,
+                })
+                .option('dependencies', {
+                    type: 'boolean',
+                    alias: 'D',
+                    group: 'Options for build:',
+                    describe: 'create templates for all dependencies of the metadata component',
+                })
+                .option('retrieve', {
+                    type: 'boolean',
+                    alias: 'r',
+                    group: 'Options for build:',
+                    describe:
+                        're-retrieves potentially relevant metadata before running buildTemplate (all if --dependencies is used)',
                 }),
         (argv) => {
             Mcdev.setOptions(argv);
@@ -397,6 +427,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('metadata', {
                     type: 'string',
+                    array: true,
                     alias: 'm',
                     group: 'Options for buildTemplate:',
                     describe: 'type:key combos to build template for',
@@ -405,6 +436,27 @@ yargs(hideBin(process.argv))
                     type: 'string',
                     group: 'Options for buildTemplate:',
                     describe: 'market used for reverse building template',
+                })
+                .option('dependencies', {
+                    type: 'boolean',
+                    alias: 'D',
+                    group: 'Options for buildTemplate:',
+                    describe: 'create templates for all dependencies of the metadata component',
+                })
+                .option('retrieve', {
+                    type: 'boolean',
+                    alias: 'r',
+                    group: 'Options for buildTemplate:',
+                    describe:
+                        're-retrieves potentially relevant metadata before building (all if --dependencies is used)',
+                })
+                .check((argv) => {
+                    if (!argv.MARKET && !argv.market) {
+                        throw new Error(
+                            'Error: You need to provide a market for reverse building the template'
+                        );
+                    }
+                    return true;
                 }),
         (argv) => {
             Mcdev.setOptions(argv);
@@ -444,6 +496,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('metadata', {
                     type: 'string',
+                    array: true,
                     alias: 'm',
                     group: 'Options for buildDefinition:',
                     describe: 'type:templateName combos to build template for',
@@ -452,6 +505,14 @@ yargs(hideBin(process.argv))
                     type: 'string',
                     group: 'Options for buildDefinition:',
                     describe: 'market used for building deployable definition',
+                })
+                .check((argv) => {
+                    if (!argv.MARKET && !argv.market) {
+                        throw new Error(
+                            'Error: You need to provide a market for reverse building the template'
+                        );
+                    }
+                    return true;
                 }),
         (argv) => {
             Mcdev.setOptions(argv);
@@ -487,6 +548,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('metadata', {
                     type: 'string',
+                    array: true,
                     alias: 'm',
                     group: 'Options for buildDefinitionBulk:',
                     describe: 'type:templateName combos to build template for',
@@ -613,6 +675,13 @@ yargs(hideBin(process.argv))
                     type: 'string',
                     describe: 'key(s) of the metadata component(s)',
                 })
+                .option('metadata', {
+                    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',
+                })
                 .option('like', {
                     type: 'string',
                     group: 'Options for execute:',
@@ -625,11 +694,60 @@ yargs(hideBin(process.argv))
                     describe:
                         'optionally start existing schedule instead of running item once immediately (only works for automations)',
                 }),
-        // TODO: add option --metadata
         (argv) => {
             Mcdev.setOptions(argv);
-            // ! do not allow multiple types to be passed in here via csvToArray
-            Mcdev.execute(argv.BU, argv.TYPE, csvToArray(argv.KEY));
+            const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
+            if ('undefined' === typeof typeKeyCombo) {
+                Mcdev.execute(argv.BU, csvToArray(argv.TYPE), csvToArray(argv.KEY));
+            } else {
+                Mcdev.execute(argv.BU, typeKeyCombo);
+            }
+        }
+    )
+    .command(
+        ['publish <BU> [TYPE] [KEY]'],
+        'publishes the entity',
+        (yargs) =>
+            yargs
+                .positional('BU', {
+                    type: 'string',
+                    describe: 'the business unit where to start an item',
+                })
+                .positional('TYPE', {
+                    type: 'string',
+                    describe: 'metadata type',
+                })
+                .positional('KEY', {
+                    type: 'string',
+                    describe: 'key(s) of the metadata component(s)',
+                })
+                .option('metadata', {
+                    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',
+                })
+                .option('like', {
+                    type: 'string',
+                    group: 'Options for publish:',
+                    describe:
+                        'filter metadata components (can include % as wildcard or _ for a single character)',
+                })
+                .option('skipStatusCheck', {
+                    group: 'Options for publish:',
+                    describe:
+                        'if you don not care if publishing actually worked you can skip the checks',
+                }),
+
+        (argv) => {
+            Mcdev.setOptions(argv);
+            const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
+            if ('undefined' === typeof typeKeyCombo) {
+                Mcdev.publish(argv.BU, csvToArray(argv.TYPE), csvToArray(argv.KEY));
+            } else {
+                Mcdev.publish(argv.BU, typeKeyCombo);
+            }
         }
     )
     .command(
@@ -649,17 +767,27 @@ yargs(hideBin(process.argv))
                     type: 'string',
                     describe: 'key(s) of the metadata component(s)',
                 })
+                .option('metadata', {
+                    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',
+                })
                 .option('like', {
                     type: 'string',
-                    group: 'Options for execute:',
+                    group: 'Options for schedule:',
                     describe:
                         'filter metadata components (can include % as wildcard or _ for a single character)',
                 }),
-        // TODO: add option --metadata
         (argv) => {
             Mcdev.setOptions(argv);
-            // ! do not allow multiple types to be passed in here via csvToArray
-            Mcdev.schedule(argv.BU, argv.TYPE, csvToArray(argv.KEY));
+            const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
+            if ('undefined' === typeof typeKeyCombo) {
+                Mcdev.schedule(argv.BU, csvToArray(argv.TYPE), csvToArray(argv.KEY));
+            } else {
+                Mcdev.schedule(argv.BU, typeKeyCombo);
+            }
         }
     )
     .command(
@@ -679,17 +807,27 @@ yargs(hideBin(process.argv))
                     type: 'string',
                     describe: 'key(s) of the metadata component(s)',
                 })
+                .option('metadata', {
+                    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',
+                })
                 .option('like', {
                     type: 'string',
                     group: 'Options for pause:',
                     describe:
                         'filter metadata components (can include % as wildcard or _ for a single character)',
                 }),
-        // TODO: add option --metadata
         (argv) => {
             Mcdev.setOptions(argv);
-            // ! do not allow multiple types to be passed in here via csvToArray
-            Mcdev.pause(argv.BU, argv.TYPE, csvToArray(argv.KEY));
+            const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
+            if ('undefined' === typeof typeKeyCombo) {
+                Mcdev.pause(argv.BU, csvToArray(argv.TYPE), csvToArray(argv.KEY));
+            } else {
+                Mcdev.pause(argv.BU, typeKeyCombo);
+            }
         }
     )
     .command(
@@ -711,6 +849,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('metadata', {
                     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',
@@ -774,6 +913,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('metadata', {
                     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',
@@ -789,6 +929,7 @@ yargs(hideBin(process.argv))
                 })
                 .option('skipRetrieve', {
                     type: 'boolean',
+                    alias: 'sr',
                     group: 'Optional parameters for replaceContentBlock:',
                     describe:
                         'if you have already just downloaded the metadata and want to skip the retrieve step',
@@ -822,6 +963,30 @@ yargs(hideBin(process.argv))
             Mcdev.replaceCbReference(argv.bu, typeKeyCombo, argv.to, argv.from);
         }
     )
+    .command(
+        ['describeSoap <TYPE>', 'describe', 'soap'],
+        'Contributor help: describes SOAP API objects and fields',
+        (yargs) =>
+            yargs
+                .positional('TYPE', {
+                    type: 'string',
+                    describe: 'Soap object name',
+                })
+                .option('bu', {
+                    type: 'string',
+                    group: 'Optional parameters for describeSoap:',
+                    describe: 'defaults to _ParentBU_ but if you',
+                })
+                .option('json', {
+                    type: 'boolean',
+                    group: 'Options for describeSoap:',
+                    describe: 'optionaly return info in json format',
+                }),
+        (argv) => {
+            Mcdev.setOptions(argv);
+            Mcdev.describeSoap(argv.TYPE, argv.bu);
+        }
+    )
     .command(
         ['upgrade', 'up'],
         'Add NPM dependencies and IDE configuration files to your project',