mcdev 3.1.1 → 4.0.0

package/lib/metadataTypes/Campaign.js

@@ -1,122 +1,62 @@
 'use strict';
 
+const TYPE = require('../../types/mcdev.d');
 const MetadataType = require('./MetadataType');
 const Util = require('../util/util');
 const File = require('../util/file');
 
 /**
  * Campaign MetadataType
+ *
  * @augments MetadataType
  */
 class Campaign extends MetadataType {
     /**
      * Retrieves Metadata of campaigns. Afterwards, starts metadata retrieval for their campaign assets
-     * @param {String} retrieveDir Directory where retrieved metadata directory will be saved
-     * @returns {Promise} Promise
+     *
+     * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
+     * @param {void} [_] unused parameter
+     * @param {void} [__] unused parameter
+     * @param {void} [___] unused parameter
+     * @param {string} [key] customer key of single item to retrieve
+     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
-    static retrieve(retrieveDir) {
-        return new Promise((resolve) => {
-            const config = {
-                props: null,
-                options: {},
-            };
-            this.client.campaign(config).get(async (error, response) => {
-                if (error) {
-                    throw new Error(error);
-                }
-                // Save metadata structure
-                const metadata = Campaign.parseResponseBody(response.body);
-                // Util.logger.info('Campaign.retrieve:: Parsed Response');
-                // Write metadata to local filesystem
-                for (const metadataEntry in metadata) {
-                    File.writeJSONToFile(
-                        retrieveDir + '/campaign/' + metadataEntry + '/',
-                        metadataEntry + '.' + this.definition.type + '-meta',
-                        metadata[metadataEntry]
-                    );
-                }
-                const campaignAssetPromises = [];
-                for (const campaign in metadata) {
-                    try {
-                        campaignAssetPromises.push(
-                            Campaign._retrieveCampaignAsset(
-                                retrieveDir,
-                                metadata[campaign].id,
-                                metadata[campaign].name
-                            )
-                        );
-                    } catch (ex) {
-                        Util.logger.error(ex.message);
-                    }
-                }
-                const values = await Promise.all(campaignAssetPromises);
-                Util.logger.info(
-                    `Downloaded: ${this.definition.type} (${Object.keys(metadata).length})`
-                );
-                resolve({ metadata: values, type: 'campaign' });
-            });
-        });
-    }
+    static async retrieve(retrieveDir, _, __, ___, key) {
+        const res = await super.retrieveREST(retrieveDir, '/hub/v1/campaigns', null, null, key);
+        // get assignments
 
-    /**
-     * Retrieves campaign asset for a specific campaign
-     * @param {String} retrieveDir Directory where retrieved metadata directory will be saved
-     * @param {Number} id id of the parent campaign
-     * @param {String} name name of the parent campaign
-     * @returns {Promise} Promise
-     */
-    static _retrieveCampaignAsset(retrieveDir, id, name) {
-        return new Promise((resolve, reject) => {
-            const config = {
-                props: { id: id },
-                options: {},
-            };
-            this.client.campaignAsset(config).get((error, response) => {
-                if (error) {
-                    reject(error);
-                } else {
-                    const assets = Campaign._parseAssetResponseBody(response.body);
+        const campaignAssets = await Promise.all(
+            Object.keys(res.metadata).map((key) =>
+                this.getAssetTags(retrieveDir, res.metadata[key].id, key)
+            )
+        );
+        Util.logger.info(`Downloaded: campaignAssets (${campaignAssets.flat().length})`);
 
-                    for (const asset in assets) {
-                        File.writeJSONToFile(
-                            retrieveDir + '/campaign/' + name + '/assets/',
-                            asset + '.campaignAsset-meta',
-                            assets[asset]
-                        );
-                    }
-                    resolve(assets);
-                }
-            });
-        });
+        return res;
     }
 
     /**
      * Parses campaign asset response body and returns metadata entries mapped to their id
-     * @param {Object} body response body of metadata retrieval
-     * @returns {Object} keyField => metadata map
+     *
+     * @param {string} retrieveDir folder where to save
+     * @param {string} id of camapaign to retrieve
+     * @param {string} name of camapaign for saving
+     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Campaign Asset Object
      */
-    static _parseAssetResponseBody(body) {
-        const metadataStructure = {};
-        if (body.items) {
-            for (let i = 0; i < body.items.length; i++) {
-                const item = body.items[i];
-                // if needed: Makes sure files can be saved on windows operating systems
-                // .replace(/[/\\?%*:|"<>]/g, '-');
-                const key = item.id;
-                metadataStructure[key] = item;
-            }
-        } else {
-            Util.logger.debug(
-                `Campaign._parseAssetResponseBody:: Format of 'body' parameter wrong: `,
-                body
+    static async getAssetTags(retrieveDir, id, name) {
+        const res = await this.client.rest.getBulk(`/hub/v1/campaigns/${id}/assets`);
+
+        for (const asset of res.items) {
+            await File.writeJSONToFile(
+                `${retrieveDir}/campaign/${name}/assets/`,
+                asset.id + '.campaignAsset-meta',
+                asset
             );
         }
-        return metadataStructure;
+        return res.items;
     }
 }
 // Assign definition to static attributes
 Campaign.definition = require('../MetadataTypeDefinitions').campaign;
-Campaign.client = undefined;
-Campaign.cache = {};
 
 module.exports = Campaign;

package/lib/metadataTypes/ContentArea.js

@@ -1,43 +1,63 @@
 'use strict';
 
+const TYPE = require('../../types/mcdev.d');
 const MetadataType = require('./MetadataType');
 const Util = require('../util/util');
+const cache = require('../util/cache');
 
 /**
  * ContentArea MetadataType
+ *
  * @augments MetadataType
  */
 class ContentArea extends MetadataType {
     /**
      * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
-     * @param {String} retrieveDir Directory where retrieved metadata directory will be saved
-     * @returns {Promise<Object>} Promise of metadata
+     *
+     * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
+     * @param {void} [_] unused parameter
+     * @param {void} [__] unused parameter
+     * @param {void} [___] unused parameter
+     * @param {string} [key] customer key of single item to retrieve
+     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
      */
-    static retrieve(retrieveDir) {
+    static retrieve(retrieveDir, _, __, ___, key) {
         Util.logger.warn(
-            'Classic Content Areas are deprecated and will be discontinued by SFMC in the near future. Ensure that you migrate any existing Content Areas to Content Builder as soon as possible.'
+            ' - Classic Content Areas are deprecated and will be discontinued by SFMC in the near future. Ensure that you migrate any existing Content Areas to Content Builder as soon as possible.'
         );
+        /** @type {TYPE.SoapRequestParams} */
+        let requestParams = null;
+        if (key) {
+            requestParams = {
+                filter: {
+                    leftOperand: 'CustomerKey',
+                    operator: 'equals',
+                    rightOperand: key,
+                },
+            };
+        }
         // !dont activate `await File.initPrettier('html');` as we only want to retrieve for migration and formatting might mess with the outcome
-        return super.retrieveSOAPgeneric(retrieveDir);
+        return super.retrieveSOAP(retrieveDir, null, requestParams);
     }
     /**
      * manages post retrieve steps
-     * @param {Object} metadata a single query
-     * @returns {Object[]} Array with one metadata object and one query string
+     *
+     * @param {TYPE.MetadataTypeItem} metadata a single item
+     * @returns {TYPE.MetadataTypeItem} parsed item
      */
     static postRetrieveTasks(metadata) {
         return this.parseMetadata(metadata);
     }
     /**
      * parses retrieved Metadata before saving
-     * @param {Object} metadata a single query activity definition
-     * @returns {Array} Array with one metadata object and one sql string
+     *
+     * @param {TYPE.MetadataTypeItem} metadata a single item
+     * @returns {TYPE.MetadataTypeItem} parsed item
      */
     static parseMetadata(metadata) {
         // folder
         try {
-            metadata.r__folder_Path = Util.getFromCache(
-                this.cache,
+            metadata.r__folder_Path = cache.searchForField(
                 'folder',
                 metadata.CategoryID,
                 'ID',