mcdev 5.2.0 → 5.3.0

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

@@ -1,6 +1,15 @@
 module.exports = {
     bodyIteratorField: 'setDefinition',
-    dependencies: ['folder-hidden', 'folder-dataextension', 'dataExtension'], // 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,
@@ -13,9 +22,9 @@ module.exports = {
     lastmodNameField: null,
     restPagination: false, // Hub API does not support pagination and returns everything instead
     type: 'attributeSet',
-    typeDescription: 'BETA: Data Extensions linked to Attribute Groups in Data Designer.',
-    typeRetrieveByDefault: false,
-    typeName: 'Data Designer Set Definitions',
+    typeDescription: 'Data Extensions linked together in Attribute Groups in Data Designer.',
+    typeRetrieveByDefault: true,
+    typeName: 'Data Designer Attribute Sets',
     fields: {
         applicationID: {
             isCreateable: null,
@@ -119,6 +128,12 @@ module.exports = {
             retrieving: true,
             template: null,
         },
+        'dataRetentionProperties.periodLength': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: null,
+        },
         definitionID: {
             isCreateable: null,
             isUpdateable: null,
@@ -138,14 +153,14 @@ module.exports = {
             template: false,
         },
         'definitionName.value': {
-            // equal to 'name'; auto-populated by preDeployTasks
+            // equal to 'name'
             isCreateable: true,
             isUpdateable: true,
             retrieving: false,
             template: false,
         },
         fullyQualifiedName: {
-            // equal to 'name'; auto-populated by preDeployTasks
+            // equal to 'name'
             isCreateable: true,
             isUpdateable: true,
             retrieving: false,
@@ -602,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': {
@@ -613,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,
@@ -622,7 +644,7 @@ module.exports = {
         'valueDefinitions[].dataSourceName': {
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].dataType': {
@@ -638,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': {
@@ -649,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': {
@@ -662,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': {
@@ -727,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': {
@@ -739,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,
@@ -770,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': {
@@ -788,9 +823,10 @@ module.exports = {
             template: null,
         },
         'valueDefinitions[].parentType': {
+            // always "Set"
             isCreateable: null,
             isUpdateable: null,
-            retrieving: true,
+            retrieving: false,
             template: null,
         },
         'valueDefinitions[].restrictionLookupListID': {
@@ -817,40 +853,51 @@ 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: true,
+            retrieving: false,
             template: null,
         },
         r__folder_Path: {
@@ -859,5 +906,11 @@ module.exports = {
             retrieving: true,
             template: null,
         },
+        r__dataExtension_CustomerKey: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: null,
+        },
     },
 };

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

@@ -31,6 +31,7 @@ module.exports = {
         'importFile',
         'query',
         'script',
+        'verification',
     ],
     folderType: 'automation',
     hasExtended: false,

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/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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "5.2.0",
+    "version": "5.3.0",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -65,7 +65,7 @@
         "console.table": "0.10.0",
         "deep-equal": "2.2.2",
         "fs-extra": "11.1.0",
-        "inquirer": "8.2.5",
+        "inquirer": "8.2.6",
         "json-to-table": "4.2.1",
         "mustache": "4.2.0",
         "p-limit": "3.1.0",
@@ -82,19 +82,19 @@
     "devDependencies": {
         "assert": "2.0.0",
         "axios-mock-adapter": "1.21.5",
-        "chai": "4.3.7",
+        "chai": "4.3.8",
         "chai-files": "1.4.0",
-        "eslint": "8.46.0",
+        "eslint": "8.48.0",
         "eslint-config-prettier": "9.0.0",
         "eslint-config-ssjs": "1.1.11",
-        "eslint-plugin-jsdoc": "46.4.6",
+        "eslint-plugin-jsdoc": "46.5.0",
         "eslint-plugin-mocha": "10.1.0",
         "eslint-plugin-prettier": "4.2.1",
         "eslint-plugin-unicorn": "48.0.0",
         "fast-xml-parser": "4.2.7",
         "husky": "8.0.3",
         "jsdoc-to-markdown": "8.0.0",
-        "lint-staged": "13.2.3",
+        "lint-staged": "14.0.1",
         "mocha": "10.2.0",
         "mock-fs": "5.2.0",
         "npm-check": "6.0.1",

package/test/mockRoot/.mcdevrc.json

@@ -78,5 +78,5 @@
             "triggeredSend"
         ]
     },
-    "version": "5.2.0"
+    "version": "5.3.0"
 }

package/test/mockRoot/deploy/testInstance/_ParentBU_/dataExtension/testExisting_dataExtensionShared.dataExtension-meta.json

@@ -0,0 +1,59 @@
+{
+    "CustomerKey": "testExisting_dataExtensionShared",
+    "Name": "testExisting_dataExtensionShared",
+    "Description": "Container for my test emails",
+    "IsSendable": true,
+    "IsTestable": true,
+    "SendableDataExtensionField": { "Name": "ContactKey" },
+    "SendableSubscriberField": { "Name": "Subscriber Key" },
+    "DataRetentionPeriodLength": 6,
+    "DataRetentionPeriodUnitOfMeasure": 5,
+    "RowBasedRetention": true,
+    "ResetRetentionPeriodOnImport": false,
+    "DeleteAtEndOfRetentionPeriod": false,
+    "RetainUntil": "",
+    "Fields": [
+        {
+            "Name": "FirstName",
+            "DefaultValue": "",
+            "MaxLength": 50,
+            "IsRequired": false,
+            "IsPrimaryKey": false,
+            "FieldType": "Text"
+        },
+        {
+            "Name": "LastName",
+            "DefaultValue": "",
+            "MaxLength": 55,
+            "IsRequired": false,
+            "IsPrimaryKey": false,
+            "FieldType": "Text"
+        },
+        {
+            "Name": "EmailAddress",
+            "DefaultValue": "",
+            "MaxLength": 254,
+            "IsRequired": true,
+            "IsPrimaryKey": false,
+            "FieldType": "EmailAddress"
+        },
+        {
+            "Name": "newField",
+            "DefaultValue": "",
+            "MaxLength": 254,
+            "IsRequired": false,
+            "IsPrimaryKey": false,
+            "FieldType": "Text"
+        },
+        {
+            "Name": "ContactKey",
+            "DefaultValue": "",
+            "MaxLength": 50,
+            "IsRequired": true,
+            "IsPrimaryKey": true,
+            "FieldType": "Text"
+        }
+    ],
+    "r__folder_ContentType": "shared_dataextension",
+    "r__folder_Path": "Shared Items/Shared Data Extensions"
+}

package/test/mockRoot/deploy/testInstance/_ParentBU_/dataExtension/testNew_dataExtensionShared.dataExtension-meta.json

@@ -0,0 +1,23 @@
+{
+    "CustomerKey": "testNew_dataExtensionShared",
+    "Name": "testNew_dataExtensionShared",
+    "Description": "",
+    "IsSendable": false,
+    "IsTestable": false,
+    "RowBasedRetention": false,
+    "ResetRetentionPeriodOnImport": false,
+    "DeleteAtEndOfRetentionPeriod": false,
+    "RetainUntil": "",
+    "Fields": [
+        {
+            "Name": "testField",
+            "DefaultValue": "",
+            "MaxLength": 254,
+            "IsRequired": true,
+            "IsPrimaryKey": false,
+            "FieldType": "Text"
+        }
+    ],
+    "r__folder_ContentType": "shared_dataextension",
+    "r__folder_Path": "Shared Items/Shared Data Extensions"
+}

package/test/mockRoot/deploy/testInstance/testBU/automation/testNew_automation.automation-meta.json

@@ -36,6 +36,10 @@
                 {
                     "name": "testExisting_script",
                     "r__type": "script"
+                },
+                {
+                    "name": "testNew_39f6a488-20eb-4ba0-b0b9",
+                    "r__type": "verification"
                 }
             ],
             "name": ""

package/test/mockRoot/deploy/testInstance/testBU/dataExtension/testExisting_dataExtension.dataExtension-meta.json

@@ -31,6 +31,7 @@
         },
         {
             "Name": "EmailAddress",
+            "Name_new": "Email",
             "DefaultValue": "",
             "MaxLength": 254,
             "IsRequired": true,

package/test/mockRoot/deploy/testInstance/testBU/transactionalEmail/testExisting_temail.transactionalEmail-meta.json

@@ -6,9 +6,6 @@
     "status": "Active",
     "createdDate": "2020-09-10T03:29:00",
     "modifiedDate": "2020-09-10T03:29:00",
-    "content": {
-        "customerKey": "testExisting_asset_message"
-    },
     "subscriptions": {
         "dataExtension": "testExisting_dataExtension",
         "autoAddSubscriber": true,
@@ -17,5 +14,7 @@
     },
     "options": {
         "trackLinks": true
-    }
+    },
+    "r__journey_key": "testExisting_interaction",
+    "r__asset_customerKey": "testExisting_asset_message"
 }

package/test/mockRoot/deploy/testInstance/testBU/transactionalEmail/testNew_temail.transactionalEmail-meta.json

@@ -6,9 +6,6 @@
     "status": "Active",
     "createdDate": "2020-09-10T03:29:00",
     "modifiedDate": "2020-09-10T03:29:00",
-    "content": {
-        "customerKey": "testExisting_asset_message"
-    },
     "subscriptions": {
         "dataExtension": "testExisting_dataExtension",
         "autoAddSubscriber": true,
@@ -18,7 +15,5 @@
     "options": {
         "trackLinks": true
     },
-    "journey": {
-        "interactionKey": "testExisting_interaction"
-    }
+    "r__asset_customerKey": "testExisting_asset_message"
 }

package/test/mockRoot/deploy/testInstance/testBU/verification/testExisting_39f6a488-20eb-4ba0-b0b9.verification-meta.json

@@ -0,0 +1,11 @@
+{
+    "dataVerificationDefinitionId": "testExisting_39f6a488-20eb-4ba0-b0b9",
+    "notificationEmailAddress": "test@accenture.com",
+    "notificationEmailMessage": "",
+    "r__dataExtension_CustomerKey": "testExisting_dataExtension",
+    "shouldEmailOnFailure": true,
+    "shouldStopOnFailure": true,
+    "value1": 1,
+    "value2": 0,
+    "verificationType": "IsEqualTo"
+}

package/test/mockRoot/deploy/testInstance/testBU/verification/testNew_39f6a488-20eb-4ba0-b0b9.verification-meta.json

@@ -0,0 +1,11 @@
+{
+    "dataVerificationDefinitionId": "testNew_39f6a488-20eb-4ba0-b0b9",
+    "notificationEmailAddress": "",
+    "notificationEmailMessage": "",
+    "r__dataExtension_CustomerKey": "testExisting_dataExtension",
+    "shouldEmailOnFailure": false,
+    "shouldStopOnFailure": false,
+    "value1": 2,
+    "value2": 0,
+    "verificationType": "IsEqualTo"
+}

package/test/resources/1111111/data/v1/customobjectdata/key/testExisting_dataExtensionShared/rowset/get-response.json

@@ -0,0 +1,13 @@
+{
+    "links": {
+        "self": "/v1/customobjectdata/token/ea0a44dc-b679-4d7d-8b77-e5d3f106e854/rowset?$page=1"
+    },
+    "requestToken": "ea0a44dc-b679-4d7d-8b77-e5d3f106e854",
+    "tokenExpireDateUtc": "2023-01-26T13:54:59.883",
+    "customObjectId": "30400c03-0ec4-ec11-b83c-48df37d1de8b",
+    "customObjectKey": "testExisting_dataExtensionShared",
+    "pageSize": 1,
+    "page": 1,
+    "count": 0,
+    "top": 0
+}

package/test/resources/1111111/dataExtension/create-expected.json

@@ -0,0 +1,23 @@
+{
+    "CustomerKey": "testNew_dataExtensionShared",
+    "DeleteAtEndOfRetentionPeriod": false,
+    "Description": "",
+    "Fields": [
+        {
+            "DefaultValue": "",
+            "FieldType": "Text",
+            "IsPrimaryKey": false,
+            "IsRequired": true,
+            "MaxLength": 254,
+            "Name": "testField"
+        }
+    ],
+    "IsSendable": false,
+    "IsTestable": false,
+    "Name": "testNew_dataExtensionShared",
+    "ResetRetentionPeriodOnImport": false,
+    "RetainUntil": "",
+    "RowBasedRetention": false,
+    "r__folder_ContentType": "shared_dataextension",
+    "r__folder_Path": "Shared Items/Shared Data Extensions"
+}