mcdev 8.2.1 → 8.3.0

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

@@ -0,0 +1,168 @@
+export default {
+    bodyIteratorField: 'items',
+    dependencies: ['folder-filterdefinition', 'folder-hidden', 'dataExtension'],
+    dependencyGraph: {
+        dataExtension: ['r__source_dataExtension_key'],
+    },
+    filter: {},
+    hasExtended: false,
+    idField: 'id',
+    keyIsFixed: false,
+    keyField: 'key',
+    nameField: 'name',
+    folderType: 'filterdefinition',
+    folderIdField: 'categoryId',
+    createdDateField: 'createdDate',
+    createdNameField: 'createdBy',
+    lastmodDateField: 'lastUpdated',
+    lastmodNameField: 'lastUpdatedBy',
+    restPagination: true,
+    restPageSize: 100,
+    maxKeyLength: 36, // confirmed max length
+    type: 'dataFilter',
+    soapType: 'FilterDefinition',
+    typeDescription: 'Defines an audience based on specified rules. Used by Filter Activities.',
+    typeRetrieveByDefault: true,
+    typeName: 'Data Filter',
+    fields: {
+        // the GUI seems to ONLY send fields during update that are actually changed. It has yet to be tested if that also works with sending other fiedls as well
+        id: {
+            isCreateable: false,
+            isUpdateable: false, // included in URL
+            retrieving: false,
+            template: false,
+        },
+        key: {
+            isCreateable: true,
+            isUpdateable: true, // can be updated
+            retrieving: true,
+            template: true,
+        },
+        createdDate: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        createdBy: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        owner: {
+            // equal to createdBy
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        createdByName: {
+            // actual name of user indicated by id in createdBy
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        lastUpdated: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        lastUpdatedBy: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        lastUpdatedByName: {
+            // actual name of user indicated by id in lastUpdatedBy
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        name: {
+            isCreateable: true,
+            isUpdateable: true, // can be updated
+            retrieving: true,
+            template: true,
+        },
+        categoryId: {
+            // returned by GET / CREATE / UPDATE; used in CREATE payload
+            isCreateable: true,
+            isUpdateable: true, // can be updated
+            retrieving: true,
+            template: true,
+        },
+        description: {
+            isCreateable: true,
+            isUpdateable: true, // can be updated
+            retrieving: true,
+            template: true,
+        },
+        filterDefinitionXml: {
+            isCreateable: true,
+            isUpdateable: true, // this is the only field that can be updated
+            retrieving: true,
+            template: true,
+        },
+        // DerivedFromType: {
+        //     // this upper-cased spelling is used by GUI when creating a dataExtension based filterDefintion
+        //     isCreateable: true,
+        //     isUpdateable: false, // cannot be updated
+        //     retrieving: false,
+        //     template: false,
+        // },
+        derivedFromType: {
+            // 1: SubscriberAttributes, 2: DataExtension, 6: EntryCriteria;
+            isCreateable: true,
+            isUpdateable: false, // cannot be updated
+            retrieving: true,
+            template: true,
+        },
+        derivedFromObjectId: {
+            // dataExtension ID or '00000000-0000-0000-0000-000000000000' for lists
+            isCreateable: true,
+            isUpdateable: false, // cannot be updated
+            retrieving: true,
+            template: true,
+        },
+        derivedFromObjectTypeName: {
+            // "SubscriberAttributes" | "DataExtension" | "EntryCriteria" ...; only returned by GET API
+            isCreateable: false,
+            isUpdateable: false, // cannot be updated
+            retrieving: true,
+            template: true,
+        },
+        derivedFromObjectName: {
+            // dataExtension name; field only returned by GET-API
+            isCreateable: false,
+            isUpdateable: false, // cannot be updated
+            retrieving: true,
+            template: true,
+        },
+        isSendable: {
+            isCreateable: false, // automatically set during create
+            isUpdateable: false, // cannot be updated
+            retrieving: true,
+            template: true,
+        },
+        r__source_dataExtension_key: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        c__filterDefinition: {
+            skipValidation: true,
+        },
+        r__folder_Path: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+    },
+};

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

@@ -0,0 +1,169 @@
+export default {
+    bodyIteratorField: 'items',
+    dependencies: ['folder-filterdefinition', 'folder-hidden', 'dataExtension'],
+    dependencyGraph: {
+        dataExtension: ['r__source_dataExtension_key'],
+    },
+    filter: {},
+    hasExtended: false,
+    idField: 'id',
+    keyIsFixed: false,
+    keyField: 'key',
+    nameField: 'name',
+    folderType: 'filterdefinition',
+    folderIdField: 'categoryId',
+    createdDateField: 'createdDate',
+    createdNameField: 'createdBy',
+    lastmodDateField: 'lastUpdated',
+    lastmodNameField: 'lastUpdatedBy',
+    restPagination: true,
+    restPageSize: 100,
+    maxKeyLength: 36, // confirmed max length
+    type: 'dataFilterHidden',
+    soapType: 'FilterDefinition',
+    typeDescription:
+        'Defines an audience based on specified rules. Auto-generated by filtered DEs and filtered Lists.',
+    typeRetrieveByDefault: false,
+    typeName: 'Data Filter (auto-generated)',
+    fields: {
+        // the GUI seems to ONLY send fields during update that are actually changed. It has yet to be tested if that also works with sending other fiedls as well
+        id: {
+            isCreateable: false,
+            isUpdateable: false, // included in URL
+            retrieving: false,
+            template: false,
+        },
+        key: {
+            isCreateable: true,
+            isUpdateable: true, // can be updated
+            retrieving: true,
+            template: true,
+        },
+        createdDate: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        createdBy: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        owner: {
+            // equal to createdBy
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        createdByName: {
+            // actual name of user indicated by id in createdBy
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        lastUpdated: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        lastUpdatedBy: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        lastUpdatedByName: {
+            // actual name of user indicated by id in lastUpdatedBy
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: false,
+        },
+        name: {
+            isCreateable: true,
+            isUpdateable: true, // can be updated
+            retrieving: true,
+            template: true,
+        },
+        categoryId: {
+            // returned by GET / CREATE / UPDATE; used in CREATE payload
+            isCreateable: true,
+            isUpdateable: true, // can be updated
+            retrieving: true,
+            template: true,
+        },
+        description: {
+            isCreateable: true,
+            isUpdateable: true, // can be updated
+            retrieving: true,
+            template: true,
+        },
+        filterDefinitionXml: {
+            isCreateable: true,
+            isUpdateable: true, // this is the only field that can be updated
+            retrieving: true,
+            template: true,
+        },
+        // DerivedFromType: {
+        //     // this upper-cased spelling is used by GUI when creating a dataExtension based filterDefintion
+        //     isCreateable: true,
+        //     isUpdateable: false, // cannot be updated
+        //     retrieving: false,
+        //     template: false,
+        // },
+        derivedFromType: {
+            // 1: SubscriberAttributes, 2: DataExtension, 6: EntryCriteria;
+            isCreateable: true,
+            isUpdateable: false, // cannot be updated
+            retrieving: true,
+            template: true,
+        },
+        derivedFromObjectId: {
+            // dataExtension ID or '00000000-0000-0000-0000-000000000000' for lists
+            isCreateable: true,
+            isUpdateable: false, // cannot be updated
+            retrieving: true,
+            template: true,
+        },
+        derivedFromObjectTypeName: {
+            // "SubscriberAttributes" | "DataExtension" | "EntryCriteria" ...; only returned by GET API
+            isCreateable: false,
+            isUpdateable: false, // cannot be updated
+            retrieving: true,
+            template: true,
+        },
+        derivedFromObjectName: {
+            // dataExtension name; field only returned by GET-API
+            isCreateable: false,
+            isUpdateable: false, // cannot be updated
+            retrieving: true,
+            template: true,
+        },
+        isSendable: {
+            isCreateable: false, // automatically set during create
+            isUpdateable: false, // cannot be updated
+            retrieving: true,
+            template: true,
+        },
+        r__source_dataExtension_key: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        c__filterDefinition: {
+            skipValidation: true,
+        },
+        r__folder_Path: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+    },
+};

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

@@ -1,12 +1,27 @@
 export default {
     bodyIteratorField: 'items',
-    dependencies: [],
-    dependencyGraph: null,
+    dependencies: [
+        'dataFilter',
+        'dataFilterHidden',
+        'list',
+        'dataExtension',
+        'folder-filteractivity',
+        'folder-hidden',
+    ],
+    dependencyGraph: {
+        filterDefinition: ['r__dataFilter_key'],
+        dataExtension: ['r__source_dataExtension_key', 'r__destination_dataExtension_key'],
+    },
     hasExtended: false,
-    idField: 'id',
-    keyIsFixed: false,
+    idField: 'filterActivityId',
+    keyIsFixed: true,
     keyField: 'customerKey',
     nameField: 'name',
+    folderType: 'filteractivity',
+    folderIdField: 'categoryId',
+    filter: {
+        statusId: 0, // exclude deleted filters
+    },
     createdDateField: 'createdDate',
     createdNameField: null,
     lastmodDateField: 'modifiedDate',
@@ -14,57 +29,90 @@ export default {
     restPagination: true,
     maxKeyLength: 36, // confirmed max length
     type: 'filter',
+    soapType: 'FilterActivity',
     typeDescription:
-        'BETA: Part of how filtered Data Extensions are created. Depends on type "FilterDefinitions".',
-    typeRetrieveByDefault: false,
+        'Used in automations to filter lists and DEs. Depends on type "FilterDefinitions".',
+    typeRetrieveByDefault: true,
     typeCdpByDefault: true,
     typeName: 'Automation: Filter Activity',
     fields: {
+        // https://developer.salesforce.com/docs/atlas.en-us.noversion.mc-apis.meta/mc-apis/filteractivity.htm
         categoryId: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
-            template: false,
+            template: true,
         },
         createdDate: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false,
             template: false,
         },
         customerKey: {
-            isCreateable: null,
-            isUpdateable: false,
+            isCreateable: false,
+            isUpdateable: true,
             retrieving: true,
+            template: true,
+        },
+        CustomerKey: {
+            isCreateable: true,
+            isUpdateable: false,
+            retrieving: false,
             template: false,
         },
         description: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
+            template: true,
+        },
+        Description: {
+            isCreateable: true,
+            isUpdateable: false,
+            retrieving: false,
             template: false,
         },
         destinationObjectId: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
+            template: true,
+        },
+        DestinationObjectID: {
+            isCreateable: true,
+            isUpdateable: false,
+            retrieving: false,
             template: false,
         },
         destinationTypeId: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
+            template: true,
+        },
+        DestinationTypeID: {
+            isCreateable: true,
+            isUpdateable: false,
+            retrieving: false,
             template: false,
         },
         filterActivityId: {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
+            isCreateable: false,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
         },
         filterDefinitionId: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
+            template: true,
+        },
+        FilterDefinitionID: {
+            isCreateable: true,
+            isUpdateable: false,
+            retrieving: false,
             template: false,
         },
         modifiedDate: {
@@ -74,28 +122,94 @@ export default {
             template: false,
         },
         name: {
-            isCreateable: null,
-            isUpdateable: false,
+            isCreateable: false,
+            isUpdateable: true,
             retrieving: true,
+            template: true,
+        },
+        Name: {
+            isCreateable: true,
+            isUpdateable: false,
+            retrieving: false,
             template: false,
         },
         sourceObjectId: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
+            template: true,
+        },
+        SourceObjectID: {
+            isCreateable: true,
+            isUpdateable: false,
+            retrieving: false,
             template: false,
         },
         sourceTypeId: {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,
+            template: true,
+        },
+        SourceTypeID: {
+            isCreateable: true,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
+        filterDefinitionSourceTypeId: {
+            isCreateable: false,
+            isUpdateable: true,
+            retrieving: false,
             template: false,
         },
         statusId: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
+            template: true,
+        },
+        resultDEName: {
+            isCreateable: false,
+            isUpdateable: true,
+            retrieving: false,
             template: false,
         },
+        resultDEKey: {
+            isCreateable: false,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        resultDEDescription: {
+            isCreateable: false,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        r__folder_Path: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        r__dataFilter_key: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        r__source_dataExtension_key: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        r__destination_dataExtension_key: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
     },
 };

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

@@ -8,7 +8,7 @@ export default {
     dependencies: [
         'folder-journey',
         'triggeredSend', // for EMAILV2-activity
-        'dataExtension', // for transactionalEmails: EMAILV2-activity
+        'dataExtension', // for transactionalEmails: EMAILV2-activity and for UPDATECONTACTDATA activity
         'deliveryProfile',
         'event', // for Multistep and Quicksend journeys
         'mobileMessage', // for SMSSYNC-activity
@@ -27,6 +27,7 @@ export default {
         dataExtension: [
             'activities.metaData.highThroughput.r__dataExtension_key',
             'activities.configurationArguments.triggeredSend.r__dataExtension_key.domainExclusions',
+            'activities.arguments.activityData.updateContactFields.r__dataExtension_key',
         ],
         deliveryProfile: ['activities.configurationArguments.triggeredSend.r__deliveryProfile_key'],
         list: [
@@ -716,6 +717,24 @@ export default {
         'activities[].schema': {
             skipValidation: true,
         },
+        'activities[].arguments.activityData.updateContactFields[].r__dataExtension_key': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        'activities[].arguments.activityData.updateContactFields[].r__dataExtensionField_name': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            template: true,
+        },
+        'activities[].arguments.activityData.updateContactFields[].field': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
         categoryId: {
             isCreateable: true,
             isUpdateable: true,

package/lib/util/devops.js

@@ -30,6 +30,7 @@ import cliProgress from 'cli-progress';
  * @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').BuildFilter} BuildFilter
  */
 
 /**
@@ -457,7 +458,9 @@ const DevOps = {
                 // remove potentially existing "description"-entry
                 delete properties.marketList[sourceML].description;
 
-                const sourceMarketBuArr = Object.keys(properties.marketList[sourceML]);
+                const sourceMarketBuArr = Object.keys(properties.marketList[sourceML]).filter(
+                    (key) => key !== 'filter'
+                );
                 if (sourceMarketBuArr.length !== 1) {
                     throw new Error('Only 1 BU is allowed per source marketList');
                 }
@@ -497,10 +500,16 @@ const DevOps = {
         for (const sourceMlName of sourceMarketListArr) {
             /** @type {string} */
             const targetMlName = sourceTargetMapping[sourceMlName];
+            const sourceMarketLists = properties.marketList[sourceMlName];
             /** @type {string} */
-            const sourceBU = Object.keys(properties.marketList[sourceMlName])[0];
+            const sourceBU = Object.keys(sourceMarketLists).find((key) => key !== 'filter');
+            // accept ["oneMarket"] or "oneMarket" for sourceMarket, but not ["oneMarket","secondMarket"] or []
             /** @type {string} */
-            const sourceMarket = Object.values(properties.marketList[sourceMlName])[0];
+            const sourceMarket =
+                Array.isArray(sourceMarketLists[sourceBU]) &&
+                sourceMarketLists[sourceBU].length === 1
+                    ? sourceMarketLists[sourceBU][0]
+                    : sourceMarketLists[sourceBU];
             if ('string' !== typeof sourceMarket) {
                 Util.logger.error(
                     'Deployment Source market list needs to have a 1:1 BU-Market combo. Your value: ' +
@@ -567,7 +576,8 @@ const DevOps = {
                     buTypeDelta[buFrom],
                     [sourceMarket],
                     [targetMlName],
-                    true
+                    true,
+                    sourceMarketLists.filter
                 );
             }
             this._generateDeleteInstructions(delta, sourceMarket, properties, targetMlName);

package/lib/util/util.js

@@ -146,7 +146,7 @@ export const Util = {
             // check if BUs in marketList are valid
             let buCounter = 0;
             for (const businessUnit in properties.marketList[mlName]) {
-                if (businessUnit !== 'description') {
+                if (businessUnit !== 'description' && businessUnit !== 'filter') {
                     buCounter++;
                     Util.isValidBU(properties, businessUnit, true);
                     if (!Util.isValidBU(properties, businessUnit, true)) {
@@ -1134,7 +1134,12 @@ export const Util = {
             String.raw`\$1`
         );
         // Replace % and _ with equivalent regex
-        search = search.replaceAll('%', '.*').replaceAll('_', '.');
+        // Replace % with .*
+        search = search.replaceAll('%', '.*');
+        // Replace _ with . only if not surrounded by [ and ]
+        search = search.replaceAll(/(?<!\[)_+(?!\])/g, (match) => '.'.repeat(match.length));
+        // replace [_] with _
+        search = search.replaceAll(String.raw`\[_\]`, '_');
         // Check matches
         return new RegExp('^' + search + '$', 'gi').test(testString);
     },