mcdev 5.1.0 → 5.3.0

package/lib/metadataTypes/definitions/{SetDefinition.definition.js → AttributeSet.definition.js}

@@ -1,20 +1,30 @@
 module.exports = {
     bodyIteratorField: 'setDefinition',
-    dependencies: [], // future may have dependency on Data Extensions
+    dependencies: [
+        'folder-hidden',
+        'folder-dataextension',
+        'folder-salesforcedataextension',
+        'folder-shared_data',
+        'folder-shared_dataextension',
+        'folder-shared_salesforcedataextension',
+        'folder-synchronizeddataextension',
+        'dataExtension',
+    ],
     hasExtended: false,
     idField: 'definitionID',
     keyIsFixed: null,
     keyField: 'definitionKey',
     nameField: 'name',
+    folderIdField: 'categoryID',
     createdDateField: 'createDate',
     createdNameField: 'createdBy',
     lastmodDateField: null,
     lastmodNameField: null,
-    restPagination: false,
-    type: 'setDefinition',
-    typeDescription: 'BETA: Data Extensions linked to Attribute Groups in Data Designer.',
-    typeRetrieveByDefault: false,
-    typeName: 'Data Designer Set Definitions',
+    restPagination: false, // Hub API does not support pagination and returns everything instead
+    type: 'attributeSet',
+    typeDescription: 'Data Extensions linked together in Attribute Groups in Data Designer.',
+    typeRetrieveByDefault: true,
+    typeName: 'Data Designer Attribute Sets',
     fields: {
         applicationID: {
             isCreateable: null,
@@ -65,10 +75,10 @@ module.exports = {
             template: null,
         },
         'connectingID.identifierType': {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
-            template: null,
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
         },
         createDate: {
             isCreateable: null,
@@ -118,29 +128,43 @@ module.exports = {
             retrieving: true,
             template: null,
         },
-        definitionID: {
+        'dataRetentionProperties.periodLength': {
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,
             template: null,
         },
-        definitionKey: {
+        definitionID: {
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,
             template: null,
         },
-        'definitionName.value': {
+        definitionKey: {
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,
             template: null,
         },
+        definitionName: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'definitionName.value': {
+            // equal to 'name'
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
         fullyQualifiedName: {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
-            template: null,
+            // equal to 'name'
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
         },
         isCustomObjectBacked: {
             isCreateable: null,
@@ -233,28 +257,28 @@ module.exports = {
             template: null,
         },
         localizedDescription: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         'localizedDescription.resourceSetKey': {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         'localizedDescription.resourceValueKey': {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         'localizedDescription.value': {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         name: {
             isCreateable: null,
@@ -436,6 +460,18 @@ module.exports = {
             retrieving: true,
             template: null,
         },
+        'relationships[].relationshipAttributes[].c__leftFullyQualifiedName': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: null,
+        },
+        'relationships[].relationshipAttributes[].c__rightFullyQualifiedName': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: null,
+        },
         'relationships[].relationshipID': {
             isCreateable: null,
             isUpdateable: null,
@@ -581,9 +617,10 @@ module.exports = {
             template: null,
         },
         'valueDefinitions[].baseType': {
+            // "Numeric", "Text", ... valueDefinitions[].dataType is more relevant
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].customerDataID': {
@@ -592,6 +629,12 @@ module.exports = {
             retrieving: true,
             template: null,
         },
+        'valueDefinitions[].connectingID': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
         'valueDefinitions[].dataSourceID': {
             isCreateable: null,
             isUpdateable: null,
@@ -601,7 +644,7 @@ module.exports = {
         'valueDefinitions[].dataSourceName': {
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].dataType': {
@@ -617,9 +660,10 @@ module.exports = {
             template: null,
         },
         'valueDefinitions[].definitionID': {
+            // likely the main ID of the value definition. No use for simple checks on git though as long as we cannot update it
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].definitionKey': {
@@ -628,10 +672,11 @@ module.exports = {
             retrieving: true,
             template: null,
         },
-        'valueDefinitions[].definitionName.value': {
+        'valueDefinitions[].definitionName': {
+            // equal to valueDefinitions[].name
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].description': {
@@ -641,15 +686,17 @@ module.exports = {
             template: null,
         },
         'valueDefinitions[].displayOrder': {
+            // merely a numeric counter; equal to valueDefinitions[].ordinal; not given for isHidden:true entries
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].fullyQualifiedName': {
+            // dataExtension name + field name
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].identifierType': {
@@ -706,10 +753,11 @@ module.exports = {
             retrieving: true,
             template: null,
         },
-        'valueDefinitions[].localizedDescription.value': {
+        'valueDefinitions[].localizedDescription': {
+            // always equal to { value: "" }
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].name': {
@@ -718,6 +766,13 @@ module.exports = {
             retrieving: true,
             template: null,
         },
+        'valueDefinitions[].obfuscationProperties': {
+            // might become relevant when fields are encrypted but for most cases we should simply skip it
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
         'valueDefinitions[].obfuscationProperties.maskType': {
             isCreateable: null,
             isUpdateable: null,
@@ -749,9 +804,10 @@ module.exports = {
             template: null,
         },
         'valueDefinitions[].ordinal': {
+            // merely a numeric counter; equal to valueDefinitions[].displayOrder; not given for isHidden:true entries
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].parentDefinition': {
@@ -767,9 +823,10 @@ module.exports = {
             template: null,
         },
         'valueDefinitions[].parentType': {
+            // always "Set"
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].restrictionLookupListID': {
@@ -796,37 +853,60 @@ module.exports = {
             retrieving: false,
             template: null,
         },
-        'valueDefinitions[].setDefinitionName.value': {
+        'valueDefinitions[].setDefinitionName': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
+        'valueDefinitions[].storageFieldReferenceID': {
             isCreateable: null,
             isUpdateable: null,
             retrieving: false,
             template: null,
         },
         'valueDefinitions[].storageFieldReferenceID.type': {
+            // always "guid"
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,
             template: null,
         },
         'valueDefinitions[].storageFieldReferenceID.value': {
+            // unknown GUID
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,
             template: null,
         },
         'valueDefinitions[].storageName': {
+            // always equal valueDefinitions[].definitionKey, except for when that is CustomObjectKey - then this will be _CustomObjectKey (with an underscore)
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].valueDefinitionID': {
+            // equal to valueDefinitions[].definitionID
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].valueDefinitionKey': {
+            // equal to valueDefinitions[].definitionKey
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: false,
+            template: null,
+        },
+        r__folder_Path: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: null,
+        },
+        r__dataExtension_CustomerKey: {
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,

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

@@ -31,6 +31,7 @@ module.exports = {
         'importFile',
         'query',
         'script',
+        'verification',
     ],
     folderType: 'automation',
     hasExtended: false,
@@ -42,12 +43,19 @@ module.exports = {
     keyField: 'key',
     nameField: 'name',
     folderIdField: 'categoryId',
-    createdDateField: 'createdDate',
-    createdNameField: 'createdByName',
-    lastmodDateField: 'lastSavedDate',
-    lastmodNameField: 'lastSavedByName',
+    createdDateField: 'createdDate', // only returned by upsert
+    createdNameField: 'createdByName', // only returned by upsert
+    lastmodDateField: 'lastSavedDate', // only returned by upsert
+    lastmodNameField: 'lastSavedByName', // only returned by upsert
     restPagination: true,
     maxKeyLength: 200, // confirmed max length
+    scheduleTypeMapping: {
+        MINUTELY: 1,
+        HOURLY: 2,
+        DAILY: 3,
+        WEEKLY: 4,
+        MONTHLY: 5,
+    },
     statusMapping: {
         AwaitingTrigger: 7,
         Building: 1,
@@ -336,31 +344,31 @@ module.exports = {
         lastSavedDate: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false, // only returned by upsert
             template: false,
         },
         lastSavedByName: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false, // only returned by upsert
             template: false,
         },
         createdDate: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false, // only returned by upsert
             template: false,
         },
         createdByName: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false, // only returned by upsertt
             template: false,
         },
         updateInProgress: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false,
             template: false,
         },
         name: {
@@ -474,8 +482,8 @@ module.exports = {
         'schedule.timezoneId': {
             isCreateable: true,
             isUpdateable: true,
-            retrieving: true,
-            template: true,
+            retrieving: false,
+            template: false,
         },
         'schedule.timezoneName': {
             isCreateable: true,
@@ -484,10 +492,10 @@ module.exports = {
             template: true,
         },
         'schedule.typeId': {
-            isCreateable: true,
-            isUpdateable: true,
-            retrieving: true,
-            template: true,
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
         },
         status: {
             isCreateable: true,

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

@@ -222,11 +222,41 @@ module.exports = {
             retrieving: true,
             template: true,
         },
-        c__dataAction: { skipValidation: true },
-        r__dataExtension_CustomerKey: { skipValidation: true },
-        c__destinationType: { skipValidation: true },
-        r__list_PathName: { skipValidation: true },
-        r__fileLocation_name: { skipValidation: true },
-        c__subscriberImportType: { skipValidation: true },
+        c__dataAction: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        r__dataExtension_CustomerKey: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        c__destinationType: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        r__list_PathName: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        r__fileLocation_name: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        c__subscriberImportType: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
     },
 };

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

@@ -83,6 +83,12 @@ module.exports = {
             retrieving: true,
             template: true,
         },
+        'subscriptions.r__dataExtension_CustomerKey': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
         'subscriptions.list': {
             isCreateable: true,
             isUpdateable: true,
@@ -127,7 +133,7 @@ module.exports = {
         },
         'options.createJourney': {
             isCreateable: true,
-            isUpdateable: true,
+            isUpdateable: false,
             retrieving: false,
             template: false,
         },
@@ -143,5 +149,17 @@ module.exports = {
             retrieving: true,
             template: true,
         },
+        r__asset_customerKey: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        r__journey_key: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
     },
 };

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

@@ -535,6 +535,7 @@ module.exports = {
         r__folder_Path: { skipValidation: true },
         r__assetMessage_Name_readOnly: { skipValidation: true },
         r__assetMessage_Key: { skipValidation: true },
+        r__email_Name: { skipValidation: true },
         r__list_PathName: { skipValidation: true },
     },
 };

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

@@ -0,0 +1,88 @@
+module.exports = {
+    bodyIteratorField: 'items',
+    dependencies: ['dataExtension'],
+    hasExtended: false,
+    idField: 'dataVerificationDefinitionId',
+    keyIsFixed: true,
+    keyField: 'dataVerificationDefinitionId',
+    createdDateField: null,
+    createdNameField: 'createdBy',
+    lastmodDateField: null,
+    lastmodNameField: null,
+    nameField: 'dataVerificationDefinitionId',
+    restPagination: false,
+    maxKeyLength: 36, // confirmed max length
+    type: 'verification',
+    typeDescription: 'Check DataExtension for a row count',
+    typeRetrieveByDefault: true,
+    typeName: 'Automation: Verification Activity',
+    fields: {
+        createdBy: {
+            // User ID
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        dataVerificationDefinitionId: {
+            isCreateable: false, // auto-assigned during creation by SFMC
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        notificationEmailAddress: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        notificationEmailMessage: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        shouldEmailOnFailure: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        shouldStopOnFailure: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        targetObjectId: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        value1: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        value2: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        verificationType: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        r__dataExtension_CustomerKey: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+    },
+};

package/lib/util/cache.js

@@ -72,10 +72,15 @@ module.exports = {
      * @returns {void}
      */
     mergeMetadata: (type, metadataMap, overrideMID) => {
-        dataStore[overrideMID || currentMID][type] = Object.assign(
-            metadataMap,
-            dataStore[currentMID][type]
-        );
+        // ensure cache exists for type
+        dataStore[currentMID][type] ||= {};
+        // if overrideMID is provided, create a copy of current MID cache
+        if (overrideMID) {
+            // ! needs to be verified if this is actually needed. When discovering an issue with this method actually overriting metadataMap, this copy-logic was present and i did not want to break things
+            dataStore[overrideMID][type] = Object.assign({}, dataStore[currentMID][type]);
+        }
+        // merge metadataMap into existing cache
+        Object.assign(dataStore[overrideMID || currentMID][type] || {}, metadataMap);
     },
     /**
      * standardized method for getting data from cache.