mcdev 7.10.1 → 8.0.1

package/lib/Deployer.js

@@ -503,6 +503,9 @@ class Deployer {
                 ) {
                     contentType = 'triggered_send_journeybuilder';
                 }
+                if (metadataType === 'asset' && folder.startsWith('CloudPages/')) {
+                    contentType = 'cloudpages';
+                }
                 folderMetadata[`on-the-fly-${i}`] = {
                     Path: folder,
                     Name: folder.split('/').pop(),

package/lib/Retriever.js

@@ -181,14 +181,20 @@ class Retriever {
                                 cache.mergeMetadata(type, result_i.metadata);
                             }
                         }
-                        if (metadataTypes.includes(type) || metadataTypes.includes(type)) {
+                        if (
+                            metadataTypes.includes(type) ||
+                            metadataTypes.some((el) => el.startsWith(type + '-'))
+                        ) {
                             retrieveChangelog[type] = result
                                 .filter((el) => !!el)
                                 .map((element) => element.metadata);
                         }
                     } else {
                         cache.mergeMetadata(type, result.metadata);
-                        if (metadataTypes.includes(type) || metadataTypes.includes(type)) {
+                        if (
+                            metadataTypes.includes(type) ||
+                            metadataTypes.some((el) => el.startsWith(type + '-'))
+                        ) {
                             retrieveChangelog[type] = result.metadata;
                         }
                     }

package/lib/cli.js

@@ -1166,6 +1166,35 @@ yargs(hideBin(process.argv))
             }
         }
     )
+    .command(
+        ['audit <BU>'],
+        'shows audit log for the entity (journey etc.)',
+        (yargs) =>
+            yargs
+                .positional('BU', {
+                    type: 'string',
+                    describe: 'the business unit where to start an item',
+                })
+                .option('metadata', {
+                    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,
+                })
+                .option('like', {
+                    type: 'string',
+                    group: 'Options for audit:',
+                    describe:
+                        'filter metadata components (can include % as wildcard or _ for a single character)',
+                }),
+        (argv) => {
+            Mcdev.setOptions(argv);
+            const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
+            Mcdev.audit(argv.BU, typeKeyCombo);
+        }
+    )
     .command(
         ['fixKeys <BU> [TYPE] [KEY]', 'fx'],
         'changes the key of the items to match the name',

package/lib/index.js

@@ -410,17 +410,7 @@ class Mcdev {
             cache.initCache(buObject);
             cred = buObject.credential;
             bu = buObject.businessUnit;
-            // clean up old folders after types were renamed
-            // TODO: Remove renamedTypes-logic 6 months after version 5 release
-            const renamedTypes = {
-                attributeSet: 'setDefinition',
-                emailSend: 'emailSendDefinition',
-                event: 'eventDefinition',
-                fileLocation: 'ftpLocation',
-                journey: 'interaction',
-                triggeredSend: 'triggeredSendDefinition',
-                user: 'accountUser',
-            };
+
             Util.logger.info('');
             Util.logger.info(`:: Retrieving ${cred}/${bu}`);
             const retrieveTypesArr = [];
@@ -444,23 +434,11 @@ class Mcdev {
                         retrieveTypesArr.push(type);
                     }
                     const areKeySet = Array.isArray(selectedTypesArr)
-                        ? keys
-                        : Object.values(selectedTypesArr).filter(Boolean).length;
+                        ? !!keys
+                        : selectedTypesArr[selectedType] !== null;
                     if (!areKeySet) {
                         // dont delete directories if we are just re-retrieving a single file
                         await File.remove(File.normalizePath(removePathArr));
-                        // clean up old folders after types were renamed
-                        // TODO: Remove this with version 5.0.0
-                        if (renamedTypes[type]) {
-                            await File.remove(
-                                File.normalizePath([
-                                    properties.directories.retrieve,
-                                    cred,
-                                    bu,
-                                    renamedTypes[type],
-                                ])
-                            );
-                        }
                     }
                 }
             }
@@ -877,6 +855,7 @@ class Mcdev {
     /**
      * Retrieve a specific metadata file and templatise.
      *
+     * @deprecated Use `retrieve` followed by `build` instead. `retrieveAsTemplate` will be removed in a future version.
      * @param {string} businessUnit references credentials from properties.json
      * @param {string} selectedType supported metadata type
      * @param {string[]} name name of the metadata
@@ -885,9 +864,7 @@ class Mcdev {
      */
     static async retrieveAsTemplate(businessUnit, selectedType, name, market) {
         Util.startLogger();
-        Util.logger.warn(
-            'mcdev:: [DEPRECATED] Retrieve as Template [DEPRECATED] - use "retrieve" + "buildTemplate" instead'
-        );
+        Util.logDeprecated('retrieveAsTemplate', `'retrieve' followed by 'build'`);
         const properties = await config.getProperties();
         if (!properties) {
             return;
@@ -1555,6 +1532,17 @@ class Mcdev {
         return this.#runMethod('stop', businessUnit, selectedTypes, keys);
     }
 
+    /**
+     * stop an item
+     *
+     * @param {string} businessUnit name of BU
+     * @param {TypeKeyCombo} selectedTypes limit to given metadata types
+     * @returns {Promise.<Object.<string, Object.<string, string[]>>>} key: business unit name, key2: type, value: list of affected item keys
+     */
+    static async audit(businessUnit, selectedTypes) {
+        return this.#runMethod('audit', businessUnit, selectedTypes);
+    }
+
     /**
      * Updates the key to match the name field
      *
@@ -1738,7 +1726,7 @@ class Mcdev {
     /**
      * run a method across BUs
      *
-     * @param {'schedule'|'execute'|'pause'|'stop'|'publish'|'validate'|'fixKeys'|'replaceCbReference'|'refresh'} methodName what to run
+     * @param {'schedule'|'execute'|'pause'|'stop'|'publish'|'validate'|'fixKeys'|'replaceCbReference'|'refresh'|'audit'} methodName what to run
      * @param {string} businessUnit name of BU
      * @param {string[] | TypeKeyCombo} [selectedTypes] limit to given metadata types
      * @param {string[]} [keys] customerkey of the metadata
@@ -1827,6 +1815,14 @@ class Mcdev {
                 checkMetadataSupport = true;
                 break;
             }
+            case 'audit': {
+                lang_past = 'audited';
+                lang_present = 'auditing';
+                requireType = true;
+                requireKeyOrLike = true;
+                checkMetadataSupport = true;
+                break;
+            }
         }
 
         /** @typedef {string[]} */
@@ -1987,7 +1983,7 @@ class Mcdev {
     /**
      * helper for Mcdev.#runMethod
      *
-     * @param {'schedule'|'execute'|'pause'|'stop'|'publish'|'validate'|'fixKeys'|'replaceCbReference'|'refresh'} methodName what to run
+     * @param {'schedule'|'execute'|'pause'|'stop'|'publish'|'validate'|'fixKeys'|'replaceCbReference'|'refresh'|'audit'} methodName what to run
      * @param {string} cred name of Credential
      * @param {string} bu name of BU
      * @param {string} [type] limit execution to given metadata type
@@ -2097,7 +2093,7 @@ class Mcdev {
         for (const originalKey in metadataMap) {
             // hide postRetrieveOutput
             Util.setLoggingLevel({ silent: true });
-            metadataMap[originalKey] = MetadataTypeInfo[selectedType].postRetrieveTasks(
+            metadataMap[originalKey] = await MetadataTypeInfo[selectedType].postRetrieveTasks(
                 metadataMap[originalKey]
             );
             // reactivate logging

package/lib/metadataTypes/Asset.js

@@ -134,6 +134,7 @@ class Asset extends MetadataType {
     /**
      * Retrieves asset metadata for templating
      *
+     * @deprecated Use `retrieve` followed by `build` instead. `retrieveAsTemplate` will be removed in a future version.
      * @param {string} templateDir Directory where retrieved metadata directory will be saved
      * @param {string} name name of the metadata file
      * @param {TemplateMap} templateVariables variables to be replaced in the metadata
@@ -141,6 +142,7 @@ class Asset extends MetadataType {
      * @returns {Promise.<{metadata: AssetItem, type: string}>} Promise
      */
     static async retrieveAsTemplate(templateDir, name, templateVariables, selectedSubType) {
+        Util.logDeprecated('retrieveAsTemplate', `'retrieve' followed by 'build'`);
         const items = [];
         const subTypes = selectedSubType ? [selectedSubType] : this._getSubTypes();
         await File.initPrettier();
@@ -410,6 +412,9 @@ class Asset extends MetadataType {
                 'availableViews',
                 'data',
                 'tags',
+
+                'meta',
+                'content',
             ];
         }
 
@@ -502,7 +507,7 @@ class Asset extends MetadataType {
                 await this.requestAndSaveExtended(items, subType, retrieveDir, templateVariables);
             }
             // always show the summary even if we already had the progress bar in the console
-            Util.logger.info(`  Downloaded asset-${subType}: ${items.length}`);
+            Util.logger.info(`  Downloaded asset${subType ? '-' + subType : ''}: ${items.length}`);
         }
 
         return items;
@@ -766,6 +771,44 @@ class Asset extends MetadataType {
             }
         }
 
+        // get asset-asset
+        try {
+            if (metadata.meta?.thumbnailRefAssetId) {
+                // cloudpages', 'landingpage', 'microsite', 'interactivecontent'
+                metadata.meta.r__asset_key = cache.searchForField(
+                    'asset',
+                    metadata.meta?.thumbnailRefAssetId,
+                    'id',
+                    'customerKey'
+                );
+                delete metadata.meta.thumbnailRefAssetId;
+            }
+        } catch {
+            Util.logger.warn(
+                ` - ${this.definition.type} '${metadata[this.definition.nameField]}' (${
+                    metadata[this.definition.keyField]
+                }): Could not find associated cloudpage content with id (${metadata.meta.thumbnailRefAssetId})`
+            );
+        }
+        if (
+            ['landingpage', 'microsite', 'interactivecontent'].includes(metadata.assetType.name) &&
+            typeof metadata.content === 'string'
+        ) {
+            // cloudpages', 'landingpage', 'microsite', 'interactivecontent'
+            metadata.content = JSON.parse(metadata.content);
+        }
+
+        if (typeof metadata.data?.site?.content === 'string') {
+            // for all xx-coderesource types
+            metadata.data.site.content = JSON.parse(metadata.data.site.content);
+        }
+
+        if (metadata.meta?.cloudPages) {
+            metadata.meta.cloudPages.c__published = metadata.meta.cloudPages.publishDate
+                ? true
+                : false;
+        }
+
         // extract HTML for selected subtypes and convert payload for easier processing in MetadataType.saveResults()
         return this._extractCode(metadata);
     }
@@ -858,14 +901,22 @@ class Asset extends MetadataType {
         // folder
         this.setFolderId(metadata);
 
-        if (
-            metadata.assetType.name === 'webpage' &&
-            !cache.getByKey(this.definition.type, metadata[this.definition.keyField])
-        ) {
-            // we are attempting to CREATE a cloudpage asset which needs to be prevented.
-            throw new Error(
-                'CloudPages cannot be created via mcdev. Please create it via the UI first, then change its key to the value required by you, and finally, re-run this deployment.'
-            );
+        if (!cache.getByKey(this.definition.type, metadata[this.definition.keyField])) {
+            if (metadata.assetType.name === 'webpage') {
+                // we are attempting to CREATE a cloudpage asset which needs to be prevented.
+                throw new Error(
+                    'CloudPage content cannot be created via mcdev. Please create it via the UI first, then you can update the content or key.'
+                );
+            }
+            if (
+                this.definition.extendedSubTypes.cloudpage.includes(metadata.assetType.name) ||
+                this.definition.extendedSubTypes.coderesource.includes(metadata.assetType.name)
+            ) {
+                // if we do create those, we get the error "Asset <id> not found" because the internal endpoint internal/v2/cloudpages/sites won't find it.
+                throw new Error(
+                    'CloudPage assets cannot be created via mcdev. Please create it via the UI first, then you can update the content or key.'
+                );
+            }
         }
 
         // template-based emails
@@ -901,6 +952,33 @@ class Asset extends MetadataType {
             delete metadata.views.html.template.r__asset_key;
         }
 
+        if (metadata.meta?.r__asset_key) {
+            // cloudpages: 'landingpage', 'microsite', 'interactivecontent'
+            // get asset-asset
+            metadata.meta.thumbnailRefAssetId = cache.searchForField(
+                'asset',
+                metadata.meta.r__asset_key,
+                'customerKey',
+                'id'
+            );
+            delete metadata.meta.r__asset_key;
+        }
+        if (metadata.meta?.cloudPages?.c__published) {
+            // TODO: removal should be done via asset.definition instead
+            delete metadata.meta.cloudPages.c__published;
+        }
+        if (
+            ['landingpage', 'microsite', 'interactivecontent'].includes(metadata.assetType.name) &&
+            typeof metadata.content === 'object'
+        ) {
+            // cloudpages: 'landingpage', 'microsite', 'interactivecontent'
+            metadata.content = JSON.stringify(metadata.content);
+        }
+        if (typeof metadata.data?.site?.content === 'object') {
+            // coderesource: for all xx-coderesource types
+            metadata.data.site.content = JSON.stringify(metadata.data.site.content);
+        }
+
         // restore asset type id which is needed for deploy
         metadata.assetType.id = this.definition.typeMapping[metadata.assetType.name];
 
@@ -1166,13 +1244,33 @@ class Asset extends MetadataType {
      */
     static setFolderPath(metadata, hideWarning = false) {
         try {
-            metadata.r__folder_Path = cache.searchForField(
-                'folder',
-                metadata.category.id,
-                'ID',
-                'Path'
-            );
-            delete metadata.category;
+            // we get folders type "asset" from EID and MID to accomodate for shared assets. That however is an issue if we are retrieving a local asset with the same folder.
+            const folderId = metadata.category.id;
+            const folderMap = cache.getCache().folder;
+            if (!folderMap) {
+                throw new Error('No folders found in cache');
+            }
+            const potentialFolders = [];
+            for (const folder of Object.values(folderMap)) {
+                if (folder.ID === folderId) {
+                    if (
+                        (metadata.memberId && metadata.memberId === folder?.Client?.ID) ||
+                        folder?.Client?.ID === this.buObject.mid
+                    ) {
+                        metadata.r__folder_Path = folder.Path;
+                        delete metadata.category;
+                        return;
+                    } else {
+                        potentialFolders.push(folder);
+                    }
+                }
+            }
+            if (potentialFolders.length >= 1) {
+                metadata.r__folder_Path = potentialFolders[0].Path;
+                delete metadata.category;
+            } else {
+                throw new Error(`No folders found with ID ${folderId}`);
+            }
         } catch (ex) {
             if (!hideWarning) {
                 Util.logger.warn(
@@ -1575,6 +1673,12 @@ class Asset extends MetadataType {
 
                 break;
             }
+            case 'jscoderesource': // coderesource
+            case 'csscoderesource': // coderesource
+            case 'jsoncoderesource': // coderesource
+            case 'rsscoderesource': // coderesource
+            case 'textcoderesource': // coderesource
+            case 'xmlcoderesource': // coderesource
             case 'buttonblock': // block - Button Block
             case 'freeformblock': // block
             case 'htmlblock': // block
@@ -1587,7 +1691,17 @@ class Asset extends MetadataType {
                 // metadata.content
                 subDirArr = [this.definition.type, subType];
                 readDirArr = [deployDir, ...subDirArr];
-                const fileExtArr = ['html', 'ssjs', 'amp'];
+                const fileExtArr = [
+                    'html',
+                    'ssjs',
+                    'amp',
+                    'js',
+                    'css',
+                    'rss',
+                    'txt',
+                    'xml',
+                    'jsonc',
+                ];
                 for (const ext of fileExtArr) {
                     if (
                         await File.pathExists(
@@ -1858,6 +1972,30 @@ class Asset extends MetadataType {
                     subFolder: [customerKey],
                 };
             }
+            case 'jscoderesource': // coderesource
+            case 'csscoderesource': // coderesource
+            case 'jsoncoderesource': // coderesource
+            case 'rsscoderesource': // coderesource
+            case 'textcoderesource': // coderesource
+            case 'xmlcoderesource': {
+                // metadata.content
+                const content = metadata?.content;
+                const fileExt = metadata.assetType.name
+                    .replace('coderesource', '')
+                    .replace('text', 'txt')
+                    .replace('json', 'jsonc');
+
+                if (content?.length) {
+                    codeArr.push({
+                        subFolder: null,
+                        fileName: customerKey,
+                        fileExt: fileExt,
+                        content: content,
+                    });
+                    delete metadata.content;
+                }
+                return { json: metadata, codeArr: codeArr, subFolder: null };
+            }
             case 'buttonblock': // block-buttonblock
             case 'freeformblock': // block-freeformblock
             case 'htmlblock': // block-htmlblock