mcdev 3.1.3 → 4.0.0

package/lib/metadataTypes/SetDefinition.js

@@ -1,32 +1,44 @@
 'use strict';
 
+const TYPE = require('../../types/mcdev.d');
 const MetadataType = require('./MetadataType');
 
 /**
  * SetDefinition MetadataType
+ *
  * @augments MetadataType
  */
 class SetDefinition extends MetadataType {
     /**
      * Retrieves Metadata of schema set Definitions.
-     * @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 super.retrieveREST(retrieveDir, '/hub/v1/contacts/schema/setDefinitions', null);
+    static retrieve(retrieveDir, _, __, ___, key) {
+        return super.retrieveREST(
+            retrieveDir,
+            '/hub/v1/contacts/schema/setDefinitions',
+            null,
+            null,
+            key
+        );
     }
     /**
      * Retrieves Metadata of schema set definitions for caching.
-     * @returns {Promise} Promise
+     *
+     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static retrieveForCache() {
-        return super.retrieveREST(null, '/hub/v1/contacts/schema/setDefinitions', null);
+        return super.retrieveREST(null, '/hub/v1/contacts/schema/setDefinitions');
     }
 }
 
 // Assign definition to static attributes
 SetDefinition.definition = require('../MetadataTypeDefinitions').setDefinition;
-SetDefinition.cache = {};
-SetDefinition.client = undefined;
 
 module.exports = SetDefinition;

package/lib/metadataTypes/TriggeredSendDefinition.js

@@ -1,20 +1,29 @@
 'use strict';
 
+const TYPE = require('../../types/mcdev.d');
 const MetadataType = require('./MetadataType');
 const Util = require('../util/util');
+const cache = require('../util/cache');
 
 /**
  * MessageSendActivity MetadataType
+ *
  * @augments MetadataType
  */
 class TriggeredSendDefinition 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) {
-        const options = {
+    static retrieve(retrieveDir, _, __, ___, key) {
+        /** @type {TYPE.SoapRequestParams} */
+        let requestParams = {
             filter: {
                 leftOperand: {
                     // somehow that parameter controls visible (non deleted?) email send activities
@@ -30,12 +39,28 @@ class TriggeredSendDefinition extends MetadataType {
                 },
             },
         };
-        return super.retrieveSOAPgeneric(retrieveDir, null, options);
+        if (key) {
+            // move original filter down one level into rightOperand and add key filter into leftOperand
+            requestParams = {
+                filter: {
+                    leftOperand: {
+                        leftOperand: 'CustomerKey',
+                        operator: 'equals',
+                        rightOperand: key,
+                    },
+                    operator: 'AND',
+                    rightOperand: requestParams.filter,
+                },
+            };
+        }
+
+        return super.retrieveSOAP(retrieveDir, null, requestParams);
     }
 
     /**
      * Create a single TSD.
-     * @param {Object} metadata single metadata entry
+     *
+     * @param {TYPE.MetadataTypeItem} metadata single metadata entry
      * @returns {Promise} Promise
      */
     static create(metadata) {
@@ -44,7 +69,8 @@ class TriggeredSendDefinition extends MetadataType {
 
     /**
      * Updates a single TSD.
-     * @param {Object} metadata single metadata entry
+     *
+     * @param {TYPE.MetadataTypeItem} metadata single metadata entry
      * @returns {Promise} Promise
      */
     static update(metadata) {
@@ -52,29 +78,41 @@ class TriggeredSendDefinition extends MetadataType {
         // * this should be done manually to not accidentally purge production queues
         return super.updateSOAP(metadata);
     }
+
+    /**
+     * Delete a metadata item from the specified business unit
+     *
+     * @param {TYPE.BuObject} buObject references credentials
+     * @param {string} customerKey Identifier of data extension
+     * @returns {Promise.<boolean>} deletion success status
+     */
+    static deleteByKey(buObject, customerKey) {
+        return super.deleteByKeySOAP(buObject, customerKey, false);
+    }
+
     /**
      * checks if the current metadata entry should be saved on retrieve or not
+     *
      * @static
-     * @param {Object} metadataEntry metadata entry
+     * @param {object} metadataEntry metadata entry
      * @returns {boolean} if false, do not save
      * @memberof MetadataType
      */
     static isFiltered(metadataEntry) {
         try {
             // get folder path to be able to filter journey-created TSDs
-            const folderPath = Util.getFromCache(
-                this.cache,
+            const folderPath = cache.searchForField(
                 'folder',
                 metadataEntry.CategoryID,
                 'ID',
                 'Path'
             );
 
-            if (folderPath && folderPath.startsWith('Journey Builder Sends/')) {
+            if (folderPath?.startsWith('Journey Builder Sends/')) {
                 // filter out any triggered sends that were auto-created by journeys
                 return true;
             }
-        } catch (ex) {
+        } catch {
             // handle it in parseMetadata()
         }
         return false;
@@ -82,24 +120,25 @@ class TriggeredSendDefinition extends MetadataType {
 
     /**
      * 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 query
+     * @returns {TYPE.MetadataTypeItem} Array with one metadata object and one query string
      */
     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 query activity definition
+     * @returns {TYPE.MetadataTypeItem} Array with one metadata object and one sql string
      */
     static parseMetadata(metadata) {
         // remove IsPlatformObject, always has to be 'false'
         delete metadata.IsPlatformObject;
         // folder
         try {
-            metadata.r__folder_Path = Util.getFromCache(
-                this.cache,
+            metadata.r__folder_Path = cache.searchForField(
                 'folder',
                 metadata.CategoryID,
                 'ID',
@@ -108,34 +147,26 @@ class TriggeredSendDefinition extends MetadataType {
             delete metadata.CategoryID;
         } catch (ex) {
             Util.logger.warn(
-                `Triggered Send '${metadata.Name}'/'${metadata.CustomerKey}': ${ex.message}`
+                ` - Triggered Send '${metadata.Name}'/'${metadata.CustomerKey}': ${ex.message}`
             );
         }
         // email
         try {
             // classic
-            const classicEmail = Util.getFromCache(
-                this.cache,
-                'email',
-                metadata.Email.ID,
-                'ID',
-                'Name'
-            );
+            const classicEmail = cache.searchForField('email', metadata.Email.ID, 'ID', 'Name');
             metadata.r__email_Name = classicEmail;
             delete metadata.Email;
-        } catch (ex) {
+        } catch {
             try {
                 // content builder
-                const contentBuilderEmailName = Util.getFromCache(
-                    this.cache,
+                const contentBuilderEmailName = cache.searchForField(
                     'asset',
                     metadata.Email.ID,
                     'legacyData.legacyId',
                     'name'
                 );
                 metadata.r__assetMessage_Name = contentBuilderEmailName;
-                const contentBuilderEmailKey = Util.getFromCache(
-                    this.cache,
+                const contentBuilderEmailKey = cache.searchForField(
                     'asset',
                     metadata.Email.ID,
                     'legacyData.legacyId',
@@ -143,23 +174,19 @@ class TriggeredSendDefinition extends MetadataType {
                 );
                 metadata.r__assetMessage_Key = contentBuilderEmailKey;
                 delete metadata.Email;
-            } catch (ex) {
+            } catch {
                 Util.logger.warn(
-                    `${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': Could not find email with ID ${metadata.Email.ID} in Classic nor in Content Builder.`
+                    ` - ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': Could not find email with ID ${metadata.Email.ID} in Classic nor in Content Builder.`
                 );
             }
         }
         // List
         try {
-            metadata.r__list_PathName = Util.getListPathNameFromCache(
-                this.cache,
-                metadata.List.ID,
-                'ID'
-            );
+            metadata.r__list_PathName = cache.getListPathName(metadata.List.ID, 'ID');
             delete metadata.List;
         } catch (ex) {
             Util.logger.warn(
-                `${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': ${ex.message}`
+                ` - ${this.definition.typeName} '${metadata.Name}'/'${metadata.CustomerKey}': ${ex.message}`
             );
         }
 
@@ -167,15 +194,15 @@ class TriggeredSendDefinition extends MetadataType {
     }
     /**
      * prepares a TSD for deployment
-     * @param {Object} metadata of a single TSD
-     * @returns {Object} metadata object
+     *
+     * @param {TYPE.MetadataTypeItem} metadata of a single TSD
+     * @returns {TYPE.MetadataTypeItem} metadata object
      */
     static async preDeployTasks(metadata) {
-        const cachedVersion = this.cache[this.definition.type][metadata.CustomerKey];
+        const cachedVersion = cache.getByKey(this.definition.type, metadata.CustomerKey);
         if (
-            cachedVersion &&
-            cachedVersion.TriggeredSendStatus === 'Active' &&
-            cachedVersion.TriggeredSendStatus === metadata.TriggeredSendStatus
+            cachedVersion?.TriggeredSendStatus === 'Active' &&
+            cachedVersion?.TriggeredSendStatus === metadata.TriggeredSendStatus
         ) {
             throw new Error(
                 `Please pause the Triggered Send '${metadata.Name}' before updating it. You may do so via GUI; or via Accenture SFMC DevTools by setting TriggeredSendStatus to 'Inactive'.`
@@ -184,27 +211,20 @@ class TriggeredSendDefinition extends MetadataType {
         // re-add IsPlatformObject, required for visibility
         metadata.IsPlatformObject = false;
         // folder
-        metadata.CategoryID = Util.getFromCache(
-            this.cache,
-            'folder',
-            metadata.r__folder_Path,
-            'Path',
-            'ID'
-        );
+        metadata.CategoryID = cache.searchForField('folder', metadata.r__folder_Path, 'Path', 'ID');
         delete metadata.r__folder_Path;
         // email
         if (metadata.r__email_Name) {
             // classic
             metadata.Email = {
-                ID: Util.getFromCache(this.cache, 'email', metadata.r__email_Name, 'Name', 'ID'),
+                ID: cache.searchForField('email', metadata.r__email_Name, 'Name', 'ID'),
             };
             delete metadata.r__email_Name;
         } else if (metadata.r__assetMessage_Key) {
             // content builder
             // * this ignores r__assetMessage_Name on purpose as that is only unique per parent folder but useful during PR reviews
             metadata.Email = {
-                ID: Util.getFromCache(
-                    this.cache,
+                ID: cache.searchForField(
                     'asset',
                     metadata.r__assetMessage_Key,
                     'customerKey',
@@ -213,7 +233,7 @@ class TriggeredSendDefinition extends MetadataType {
             };
             delete metadata.r__assetMessage_Key;
             delete metadata.r__assetMessage_Name;
-        } else if (metadata.Email && metadata.Email.ID) {
+        } else if (metadata?.Email?.ID) {
             throw new Error(
                 `r__assetMessage_Key / r__email_Name not defined but instead found Email.ID. Please try re-retrieving this TSD from your BU.`
             );
@@ -221,10 +241,10 @@ class TriggeredSendDefinition extends MetadataType {
         // get List
         if (metadata.r__list_PathName) {
             metadata.List = {
-                ID: Util.getListObjectIdFromCache(this.cache, metadata.r__list_PathName, 'ID'),
+                ID: cache.getListObjectId(metadata.r__list_PathName, 'ID'),
             };
             delete metadata.r__list_PathName;
-        } else if (metadata.List && metadata.List.ID) {
+        } else if (metadata?.List?.ID) {
             throw new Error(
                 `r__list_PathName not defined but instead found List.ID. Please try re-retrieving this TSD from your BU.`
             );

package/lib/metadataTypes/definitions/Asset.definition.js

@@ -7,6 +7,10 @@ module.exports = {
     idField: 'id',
     keyField: 'customerKey',
     nameField: 'name',
+    createdDateField: 'createdDate',
+    createdNameField: 'createdBy.name',
+    lastmodDateField: 'modifiedDate',
+    lastmodNameField: 'modifiedBy.name',
     restPagination: true,
     type: 'asset',
     typeDescription: 'Assets from Content Builder grouped into subtypes.',
@@ -68,7 +72,10 @@ module.exports = {
             template: true,
         },
         businessUnitAvailability: {
-            skipValidation: true,
+            isCreateable: false,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
         },
         category: {
             isCreateable: true,
@@ -160,7 +167,7 @@ module.exports = {
         'data.approvals': {
             skipValidation: true,
         },
-        'data.email.options': {
+        'data.email.attributes': {
             skipValidation: true,
         },
         'data.email.legacy': {
@@ -169,6 +176,9 @@ module.exports = {
             retrieving: false,
             template: false,
         },
+        'data.email.options': {
+            skipValidation: true,
+        },
         'data.portfolio': {
             isCreateable: false,
             isUpdateable: false,
@@ -278,8 +288,8 @@ module.exports = {
         memberId: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: false,
-            template: false,
+            retrieving: true,
+            template: true,
         },
         meta: {
             skipValidation: true,
@@ -363,8 +373,8 @@ module.exports = {
             template: false,
         },
         sharingProperties: {
-            isCreateable: true,
-            isUpdateable: true,
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
             template: true,
         },
@@ -372,14 +382,14 @@ module.exports = {
             skipValidation: true,
         },
         'sharingProperties.sharedWith': {
-            isCreateable: true,
-            isUpdateable: true,
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
             template: true,
         },
         'sharingProperties.sharingType': {
-            isCreateable: true,
-            isUpdateable: true,
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
             template: true,
         },
@@ -448,6 +458,7 @@ module.exports = {
         'textfile',
         'video',
     ],
+    binarySubtypes: ['archive', 'audio', 'document', 'image', 'rawimage', 'video'],
     extendedSubTypes: {
         asset: ['webpage', 'webtemplate', 'jsonmessage', 'icemailformblock'],
         image: [

package/lib/metadataTypes/definitions/AttributeGroup.definition.js

@@ -191,6 +191,18 @@ module.exports = {
             retrieving: true,
             template: null,
         },
+        'localizedDescription.resourceSetKey': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: null,
+        },
+        'localizedDescription.resourceValueKey': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: null,
+        },
         'localizedDescription.value': {
             isCreateable: null,
             isUpdateable: null,

package/lib/metadataTypes/definitions/Automation.definition.js

@@ -32,6 +32,7 @@ module.exports = {
         'query',
         'script',
     ],
+    folderType: 'automation',
     hasExtended: false,
     filter: {
         description: ['Event Definition Automation'],
@@ -39,6 +40,10 @@ module.exports = {
     idField: 'id',
     keyField: 'key',
     nameField: 'name',
+    createdDateField: 'createdDate',
+    createdNameField: 'createdByName',
+    lastmodDateField: 'lastSavedDate',
+    lastmodNameField: 'lastSavedByName',
     restPagination: false,
     statusMapping: {
         AwaitingTrigger: 7,
@@ -303,7 +308,7 @@ module.exports = {
         },
         key: {
             isCreateable: true,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
             template: true,
         },
@@ -469,8 +474,8 @@ module.exports = {
         'steps[].activities[].displayOrder': {
             isCreateable: true,
             isUpdateable: true,
-            retrieving: true,
-            template: true,
+            retrieving: false,
+            template: false,
         },
         'steps[].activities[].id': {
             isCreateable: true,
@@ -536,8 +541,8 @@ module.exports = {
             template: true,
         },
         'steps[].step': {
-            isCreateable: true,
-            isUpdateable: true,
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
             template: true,
         },

package/lib/metadataTypes/definitions/Campaign.definition.js

@@ -10,5 +10,48 @@ module.exports = {
     typeDescription: 'Way of tagging/categorizing emails, journeys and alike.',
     typeRetrieveByDefault: false,
     typeName: 'Campaign Tag',
-    fields: {},
+    fields: {
+        createdDate: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            templating: false,
+        },
+        modifiedDate: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            templating: false,
+        },
+        name: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            templating: false,
+        },
+        description: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            templating: false,
+        },
+        campaignCode: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            templating: false,
+        },
+        color: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            templating: false,
+        },
+        favorite: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            templating: false,
+        },
+    },
 };

package/lib/metadataTypes/definitions/DataExtension.definition.js

@@ -80,6 +80,10 @@ module.exports = {
     idField: 'ObjectID',
     keyField: 'CustomerKey',
     nameField: 'Name',
+    createdDateField: 'CreatedDate',
+    createdNameField: null,
+    lastmodDateField: 'ModifiedDate',
+    lastmodNameField: null,
     restPagination: false,
     type: 'dataExtension',
     typeDescription: 'Database table schemas.',

package/lib/metadataTypes/definitions/DataExtensionTemplate.definition.js

@@ -60,6 +60,12 @@ module.exports = {
             retrieving: false,
             template: false,
         },
+        PartnerProperties: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
         IsSendable: { isCreateable: false, isUpdateable: false, retrieving: true, template: false },
         IsTestable: { isCreateable: false, isUpdateable: false, retrieving: true, template: false },
         SendableCustomObjectField: {

package/lib/metadataTypes/definitions/DataExtract.definition.js

@@ -4,6 +4,10 @@ module.exports = {
     hasExtended: true,
     idField: 'dataExtractDefinitionId',
     keyField: 'key',
+    createdDateField: 'createdDate',
+    createdNameField: 'createdBy',
+    lastmodDateField: 'modifiedDate',
+    lastmodNameField: 'modifiedBy',
     nameField: 'name',
     restPagination: true,
     type: 'dataExtract',
@@ -30,8 +34,8 @@ module.exports = {
             template: false,
         },
         dataExtractTypeId: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
             template: true,
         },
@@ -39,20 +43,20 @@ module.exports = {
             skipValidation: true,
         },
         description: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
             template: true,
         },
         endDate: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
             template: true,
         },
         fileSpec: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
             template: true,
         },
@@ -63,8 +67,8 @@ module.exports = {
             template: true,
         },
         key: {
-            isCreateable: null,
-            isUpdateable: false,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
             template: true,
         },
@@ -81,14 +85,14 @@ module.exports = {
             template: false,
         },
         name: {
-            isCreateable: null,
-            isUpdateable: false,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
             template: true,
         },
         startDate: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
             template: true,
         },

package/lib/metadataTypes/definitions/Discovery.definition.js

@@ -86,6 +86,18 @@ module.exports = {
         methods: {
             skipValidation: true,
         },
+        metadata: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        'metadata.supportsResponseEncoding': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
         name: {
             isCreateable: false,
             isUpdateable: false,