mcdev 7.0.4 → 7.1.1

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

@@ -1,6 +1,13 @@
 export default {
     bodyIteratorField: 'items',
-    dependencies: ['fileLocation', 'dataExtension', 'list'],
+    dependencies: ['fileLocation', 'dataExtension', 'list', 'mobileKeyword'],
+    dependencyGraph: {
+        // fileLocation cannot be deployed
+        // fileLocation: ['source.r__fileLocation_name'],
+        dataExtension: ['destination.r__dataExtension_key', 'source.r__dataExtension_key'],
+        list: ['destination.r__list_PathName'],
+        mobileKeyword: ['destination.r__mobileKeyword_key'],
+    },
     destinationObjectTypeMapping: {
         unknown: 783,
         DataExtension: 310,
@@ -124,6 +131,14 @@ export default {
             skipValidation: true,
         },
         fileNamingPattern: {
+            // for FTP-import: pattern to look for; for DE-import: "_CustomObject"
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        fileSpec: {
+            // same as fileNamingPattern
             isCreateable: true,
             isUpdateable: true,
             retrieving: true,
@@ -249,6 +264,20 @@ export default {
             retrieving: true,
             template: true,
         },
+        sourceCustomObjectId: {
+            // for FTP-import: empty string; for DE-import: dataExtension id
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        sourceDataExtensionName: {
+            // for FTP-import: empty string; for DE-import: dataExtension name
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
         c__dataAction: {
             isCreateable: false,
             isUpdateable: false,
@@ -273,7 +302,13 @@ export default {
             retrieving: true,
             template: true,
         },
-        'destination.c__destinationType': {
+        'source.c__type': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        'destination.c__type': {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,

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

@@ -20,6 +20,34 @@ export default {
         'sendClassification', // for EMAILV2-activity
         'senderProfile', // for EMAILV2-activity
     ], // ! interaction and transactionalEmail both link to each other. caching transactionalEmail here "manually" instead of via dependencies array, assuming that it is quicker than the other way round
+    dependencyGraph: {
+        // classic email cannot be deployed anymore
+        event: ['triggers.metaData.r__event_key'],
+        transactionalEmail: ['activities.configurationArguments.r__transactionalEmail_key'],
+        dataExtension: [
+            'activities.metaData.highThroughput.r__dataExtension_key',
+            'activities.configurationArguments.triggeredSend.r__dataExtension_key.domainExclusions',
+        ],
+        triggeredSend: ['activities.configurationArguments.r__triggeredSend_key'],
+        list: [
+            'activities.configurationArguments.triggeredSend.r__list_PathName.publicationList',
+            'activities.configurationArguments.triggeredSend.r__list_PathName.suppressionLists',
+        ],
+        senderProfile: ['activities.configurationArguments.triggeredSend.r__senderProfile_key'],
+        sendClassification: [
+            'activities.configurationArguments.triggeredSend.r__sendClassification_key',
+        ],
+        asset: [
+            'activities.configurationArguments.triggeredSend.r__asset_key',
+            'activities.configurationArguments.r__asset_key',
+        ],
+        mobileMessage: ['activities.configurationArguments.r__mobileMessage_key'],
+        mobileKeyword: [
+            'activities.configurationArguments.r__mobileKeyword_key.current',
+            'activities.configurationArguments.r__mobileKeyword_key.next',
+        ],
+        mobileCode: ['activities.configurationArguments.r__mobileCode_key'],
+    },
     folderIdField: 'categoryId',
     hasExtended: false,
     idField: 'id',
@@ -75,6 +103,9 @@ export default {
             retrieving: null,
             template: null,
         },
+        'defaults.properties': {
+            skipValidation: true,
+        },
         'defaults.properties.analyticsTracking.analyticsType': {
             isCreateable: null,
             isUpdateable: null,
@@ -256,6 +287,48 @@ export default {
             retrieving: true,
             template: true,
         },
+        'triggers[].arguments.serializedObjectType': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'triggers[].arguments.eventDefinitionId': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'triggers[].arguments.eventDefinitionKey': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'triggers[].arguments.dataExtensionId': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'triggers[].arguments.automationId': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'triggers[].arguments.r__event_key': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        'triggers[].arguments.r__dataExtension_key': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
         'triggers[].configurationArguments': {
             isCreateable: true,
             isUpdateable: true,
@@ -365,6 +438,24 @@ export default {
             retrieving: true,
             template: true,
         },
+        'triggers[].configurationArguments.whoToInject': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'triggers[].configurationArguments.objectApiName': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'triggers[].configurationArguments.additionalObjectFilterCriteria': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
         'triggers[].metaData': {
             isCreateable: true,
             isUpdateable: true,
@@ -372,10 +463,28 @@ export default {
             template: true,
         },
         'triggers[].metaData.sourceInteractionId': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'triggers[].metaData.entrySourceGroupConfigUrl': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'triggers[].metaData.r__event_key': {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: false,
-            template: false,
+            retrieving: true,
+            template: true,
+        },
+        'triggers[].metaData.category': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
         },
         'triggers[].metaData.eventDefinitionId': {
             isCreateable: false,

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

@@ -1,6 +1,7 @@
 export default {
     bodyIteratorField: 'Results',
     dependencies: ['folder-mysubs', 'folder-list', 'folder-publication'],
+    dependencyGraph: null,
     folderType: 'list',
     hasExtended: false,
     idField: 'ObjectID',

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

@@ -1,6 +1,7 @@
 export default {
     bodyIteratorField: 'entry',
     dependencies: [],
+    dependencyGraph: null,
     hasExtended: false,
     idField: 'id',
     keyIsFixed: true,

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

@@ -1,6 +1,7 @@
 export default {
     bodyIteratorField: 'entry',
     dependencies: ['mobileCode'],
+    dependencyGraph: { mobileCode: ['r__mobileCode_key'] },
     hasExtended: false,
     idField: 'id',
     keyIsFixed: false, // custom field but mapped to normal fields
@@ -31,6 +32,12 @@ export default {
             retrieving: true,
             template: true,
         },
+        r__mobileCode_key: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
         keyword: {
             isCreateable: true,
             isUpdateable: true,

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

@@ -1,6 +1,15 @@
 export default {
     bodyIteratorField: 'entry',
     dependencies: ['mobileCode', 'mobileKeyword', 'campaign'],
+    dependencyGraph: {
+        mobileCode: ['r__mobileCode_key'],
+        mobileKeyword: [
+            'keyword.r__mobileKeyword_key',
+            'subscriptionKeyword.r__mobileKeyword_key',
+            'nextKeyword.r__mobileKeyword_key',
+        ],
+        // campaign: ['r__campaign_key'], // campaign cannot be deployed
+    },
     hasExtended: false,
     idField: 'id',
     keepId: true,

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

@@ -1,6 +1,9 @@
 export default {
     bodyIteratorField: 'items',
     dependencies: ['folder-queryactivity', 'dataExtension'],
+    dependencyGraph: {
+        dataExtension: ['r__dataExtension_key'],
+    },
     folderType: 'queryactivity',
     filter: {
         description: ['Query created by Query Studio'],

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

@@ -1,6 +1,7 @@
 export default {
     bodyIteratorField: 'Results',
     dependencies: [],
+    dependencyGraph: null,
     deployBlacklist: [
         'SYS_DEF_ADMIN',
         'SYS_DEF_ANALYST',

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

@@ -1,6 +1,7 @@
 export default {
     bodyIteratorField: 'items',
     dependencies: ['folder-ssjsactivity'],
+    dependencyGraph: null,
     folderType: 'ssjsactivity',
     hasExtended: false,
     idField: 'ssjsActivityId',

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

@@ -2,6 +2,10 @@
 export default {
     bodyIteratorField: 'Results',
     dependencies: ['senderProfile', 'deliveryProfile'],
+    dependencyGraph: {
+        senderProfile: ['r__senderProfile_key'],
+        // deliveryProfile: ['r__deliveryProfile_key'], // deliveryProfile cannot be deployed
+    },
     filter: {},
     hasExtended: false,
     idField: 'ObjectID',

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

@@ -1,6 +1,7 @@
 export default {
     bodyIteratorField: 'Results',
     dependencies: [],
+    dependencyGraph: null,
     filter: {},
     hasExtended: false,
     idField: 'ObjectID',

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

@@ -1,6 +1,13 @@
 export default {
     bodyIteratorField: 'definitions',
     dependencies: ['asset-message', 'dataExtension', 'list', 'journey'],
+    dependencyGraph: {
+        // classic email cannot be deployed anymore
+        asset: ['r__asset_key'],
+        dataExtension: ['subscriptions.r__dataExtension_key'],
+        list: ['subscriptions.r__list_PathName'],
+        journey: ['r__journey_key'],
+    },
     hasExtended: false,
     idField: 'definitionId',
     keyIsFixed: true, // sending definitionKey in update call not allowed by API

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

@@ -1,6 +1,7 @@
 export default {
     bodyIteratorField: 'definitions',
     dependencies: [],
+    dependencyGraph: null,
     hasExtended: false,
     idField: 'definitionId',
     keyIsFixed: true, // sending definitionKey in update call not allowed by API

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

@@ -1,6 +1,9 @@
 export default {
     bodyIteratorField: 'definitions',
     dependencies: ['asset-asset'],
+    dependencyGraph: {
+        asset: ['r__asset_key'],
+    },
     hasExtended: false,
     idField: 'definitionId',
     keyIsFixed: true, // sending definitionKey in update call not allowed by API

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

@@ -1,6 +1,10 @@
 export default {
     bodyIteratorField: 'definitions',
     dependencies: ['mobileCode', 'mobileKeyword'],
+    dependencyGraph: {
+        mobileKeyword: ['subscriptions.r__mobileKeyword_key'],
+        mobileCode: ['subscriptions.r__mobileCode_key'],
+    },
     hasExtended: false,
     idField: 'definitionId',
     keyIsFixed: true, // sending definitionKey in update call not allowed by API

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

@@ -10,6 +10,13 @@ export default {
         'sendClassification',
         'senderProfile',
     ],
+    dependencyGraph: {
+        // classic email cannot be deployed anymore
+        asset: ['r__asset_key'],
+        list: ['r__list_PathName'],
+        sendClassification: ['r__sendClassification_key'],
+        senderProfile: ['r__senderProfile_key'],
+    },
     folderType: 'triggered_send',
     hasExtended: false,
     idField: 'ObjectID',
@@ -72,8 +79,8 @@ export default {
             templating: true,
         },
         CCEmail: {
-            isCreateable: false,
-            isUpdateable: false,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: false,
             templating: false,
         },
@@ -360,9 +367,9 @@ export default {
             templating: false,
         },
         PreHeader: {
-            // not supported by API
-            isCreateable: false,
-            isUpdateable: false,
+            // retrieve not supported by API
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: false,
             templating: false,
         },

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

@@ -1,6 +1,9 @@
 export default {
     bodyIteratorField: 'Results',
     dependencies: ['role'],
+    dependencyGraph: {
+        // role: ['c__RoleNamesGlobal'] // roles should rarely ever be deployed and hence this is not needed here
+    },
     folderType: null,
     hasExtended: false,
     idField: 'AccountUserID', // ID contains the same value as AccountUserID but is not required by API

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

@@ -1,6 +1,7 @@
 export default {
     bodyIteratorField: 'items',
     dependencies: ['dataExtension'],
+    dependencyGraph: { dataExtension: ['r__dataExtension_key'] },
     hasExtended: false,
     idField: 'dataVerificationDefinitionId',
     keyIsFixed: true,

package/lib/util/cache.js

@@ -18,6 +18,9 @@ import { Util } from './util.js';
  * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
  * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
  * @typedef {import('../../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
+ *
+ * @typedef {import('../../types/mcdev.d.js').ListItem} ListItem
+ * @typedef {import('../../types/mcdev.d.js').ListMap} ListMap
  */
 
 /** @type {Cache} */
@@ -144,6 +147,38 @@ export default {
             `Dependent ${metadataType} with ${searchField}='${searchValue}' was not found on your BU`
         );
     },
+    /**
+     * helper for setFolderId
+     *
+     * @param {string} r__folder_Path folder path value
+     * @param {number} [overrideMID] ignore currentMID and use alternative (for example parent MID)
+     * @returns {number} folder ID
+     */
+    getFolderId(r__folder_Path, overrideMID) {
+        if (!r__folder_Path) {
+            throw new Error('r__folder_Path not set');
+        }
+        /** @type {ListMap} */
+        const folderMap = dataStore[overrideMID || currentMID]?.['folder'];
+        if (!folderMap) {
+            throw new Error('No folders found in cache');
+        }
+        const potentialFolders = [];
+        for (const folder of Object.values(folderMap)) {
+            if (folder.Path === r__folder_Path) {
+                if (folder.Client.ID === (overrideMID || currentMID)) {
+                    return folder.ID;
+                } else {
+                    potentialFolders.push(folder);
+                }
+            }
+        }
+        if (potentialFolders.length >= 1) {
+            return potentialFolders[0].ID;
+        } else {
+            throw new Error(`No folders found with path ${r__folder_Path}`);
+        }
+    },
     /**
      * standardized method for getting data from cache - adapted for special case of lists
      * ! keeping this in util/cache.js rather than in metadataTypes/List.js to avoid potential circular dependencies