mcdev 8.2.1 → 8.3.0

package/test/type.dataFilter.test.js

@@ -0,0 +1,174 @@
+import * as chai from 'chai';
+const assert = chai.assert;
+
+import chaiFiles from 'chai-files';
+import cache from '../lib/util/cache.js';
+import * as testUtils from './utils.js';
+import handler from '../lib/index.js';
+chai.use(chaiFiles);
+
+describe('type: dataFilter', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a dataFilter', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['dataFilter']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.dataFilter ? Object.keys(result.dataFilter).length : 0,
+                1,
+                'unexpected number of items retrieved'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_dataFilter', 'dataFilter'),
+                await testUtils.getExpectedJson('9999999', 'dataFilter', 'get'),
+                'returned JSON was not equal expected'
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                6,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should retrieve a dataFilter by key', async () => {
+            // WHEN
+            await handler.retrieve(
+                'testInstance/testBU',
+                ['dataFilter'],
+                ['testExisting_dataFilter']
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.dataFilter ? Object.keys(result.dataFilter).length : 0,
+                1,
+                'only one dataFilter expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_dataFilter', 'dataFilter'),
+                await testUtils.getExpectedJson('9999999', 'dataFilter', 'get'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                7,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+
+    describe('Deploy ================', () => {
+        beforeEach(() => {
+            testUtils.mockSetup(true);
+        });
+
+        it('Should create & upsert a dataFilter', async () => {
+            // WHEN
+
+            await handler.deploy('testInstance/testBU', ['dataFilter']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.dataFilter ? Object.keys(result.dataFilter).length : 0,
+                2,
+                'unexptected number of dataFilters in cache'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_dataFilter', 'dataFilter'),
+                await testUtils.getExpectedJson('9999999', 'dataFilter', 'post'),
+                'returned new-JSON was not equal expected for insert dataFilter'
+            );
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_dataFilter', 'dataFilter'),
+                await testUtils.getExpectedJson('9999999', 'dataFilter', 'patch'),
+                'returned existing-JSON was not equal expected for update dataFilter'
+            );
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                8,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+
+    describe('Templating ================', () => {
+        it('Should create a dataFilter template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['dataFilter']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'dataFilter',
+                ['testExisting_dataFilter'],
+                ['testSourceMarket']
+            );
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
+            assert.equal(
+                result.dataFilter ? Object.keys(result.dataFilter).length : 0,
+                1,
+                'only one dataFilter expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_dataFilter', 'dataFilter'),
+                await testUtils.getExpectedJson('9999999', 'dataFilter', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'dataFilter',
+                ['testExisting_dataFilter'],
+                ['testTargetMarket']
+            );
+            assert.equal(process.exitCode, 0, 'buildDefinition should not have thrown an error');
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_dataFilter', 'dataFilter'),
+                await testUtils.getExpectedJson('9999999', 'dataFilter', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                6,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+
+    describe('Delete ================', () => {
+        it('Should delete the item', async () => {
+            // WHEN
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'dataFilter',
+                'testExisting_dataFilter'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'deleteByKey should not have thrown an error');
+            assert.equal(isDeleted, true, 'deleteByKey should have returned true');
+            return;
+        });
+    });
+});

package/test/type.filter.test.js

@@ -0,0 +1,170 @@
+import * as chai from 'chai';
+const assert = chai.assert;
+
+import chaiFiles from 'chai-files';
+import cache from '../lib/util/cache.js';
+import * as testUtils from './utils.js';
+import handler from '../lib/index.js';
+chai.use(chaiFiles);
+
+describe('type: filter', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a filter', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['filter']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.filter ? Object.keys(result.filter).length : 0,
+                1,
+                'unexpected number of items retrieved'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_filter', 'filter'),
+                await testUtils.getExpectedJson('9999999', 'filter', 'get'),
+                'returned JSON was not equal expected'
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                14,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should retrieve a filter by key', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['filter'], ['testExisting_filter']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.filter ? Object.keys(result.filter).length : 0,
+                1,
+                'only one filter expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_filter', 'filter'),
+                await testUtils.getExpectedJson('9999999', 'filter', 'get'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                15,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+
+    describe('Deploy ================', () => {
+        beforeEach(() => {
+            testUtils.mockSetup(true);
+        });
+
+        it('Should create & upsert a filter', async () => {
+            // WHEN
+
+            await handler.deploy('testInstance/testBU', ['filter']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.filter ? Object.keys(result.filter).length : 0,
+                2,
+                'unexptected number of filters in cache'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_filter', 'filter'),
+                await testUtils.getExpectedJson('9999999', 'filter', 'post'),
+                'returned new-JSON was not equal expected for insert filter'
+            );
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_filter', 'filter'),
+                await testUtils.getExpectedJson('9999999', 'filter', 'patch'),
+                'returned existing-JSON was not equal expected for update filter'
+            );
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                17,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+
+    describe('Templating ================', () => {
+        it('Should create a filter template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['filter']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'filter',
+                ['testExisting_filter'],
+                ['testSourceMarket']
+            );
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
+            assert.equal(
+                result.filter ? Object.keys(result.filter).length : 0,
+                1,
+                'only one filter expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_filter', 'filter'),
+                await testUtils.getExpectedJson('9999999', 'filter', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'filter',
+                ['testExisting_filter'],
+                ['testTargetMarket']
+            );
+            assert.equal(process.exitCode, 0, 'buildDefinition should not have thrown an error');
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_filter', 'filter'),
+                await testUtils.getExpectedJson('9999999', 'filter', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                14,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+
+    describe('Delete ================', () => {
+        it('Should delete the item', async () => {
+            // WHEN
+            const isDeleted = await handler.deleteByKey(
+                'testInstance/testBU',
+                'filter',
+                'testExisting_filter'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'deleteByKey should not have thrown an error');
+            assert.equal(isDeleted, true, 'deleteByKey should have returned true');
+            return;
+        });
+    });
+});

package/test/type.journey.test.js

@@ -26,7 +26,7 @@ describe('type: journey', () => {
             const result = cache.getCache();
             assert.equal(
                 result.journey ? Object.keys(result.journey).length : 0,
-                4,
+                5,
                 'unexpected number of journeys'
             );
             assert.deepEqual(
@@ -46,7 +46,7 @@ describe('type: journey', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                27,
+                29,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -111,6 +111,36 @@ describe('type: journey', () => {
             return;
         });
 
+        it('Should retrieve a journey containing an UPDATECONTACTDATA activity with key', async () => {
+            // WHEN
+            await handler.retrieve(
+                'testInstance/testBU',
+                ['journey'],
+                ['testExisting_journey_updatecontact']
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.journey ? Object.keys(result.journey).length : 0,
+                1,
+                'only 1 journeys expected'
+            );
+
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_journey_updatecontact', 'journey'),
+                await testUtils.getExpectedJson('9999999', 'journey', 'get-updatecontact'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                20,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
         it('Should retrieve a Transactional Email journey with key', async () => {
             // WHEN
             await handler.retrieve('testInstance/testBU', ['journey'], ['testExisting_temail']);
@@ -425,6 +455,29 @@ describe('type: journey', () => {
             );
             return;
         });
+
+        it('Should update a journey with UPDATECONTACT activity', async () => {
+            // WHEN
+            await handler.deploy(
+                'testInstance/testBU',
+                ['journey'],
+                ['testExisting_journey_updatecontact']
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
+            // // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_journey_updatecontact', 'journey'),
+                await testUtils.getExpectedJson('9999999', 'journey', 'put-updatecontact'),
+                'returned metadata was not equal expected for update journey with updatecontact activity'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                22,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
     });
 
     describe('Templating ================', () => {
@@ -466,7 +519,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                27,
+                29,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -662,7 +715,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                33,
+                35,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -697,7 +750,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                33,
+                35,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -732,7 +785,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                33,
+                35,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -1329,7 +1382,6 @@ describe('type: journey', () => {
                 ['testExisting_temail', 'testExisting_journey_Multistep'],
                 'should have found the right journeys that need updating'
             );
-
             assert.equal(
                 testUtils.getAPIHistoryLength(),
                 42,

package/test/type.query.test.js

@@ -648,7 +648,7 @@ describe('type: query', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                46,
+                47,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -690,7 +690,7 @@ describe('type: query', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                48,
+                49,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/utils.js

@@ -7,6 +7,7 @@ import auth from '../lib/util/auth.js';
 import { Util } from '../lib/util/util.js';
 import cache from '../lib/util/cache.js';
 import ReplaceContentBlockReference from '../lib/util/replaceContentBlockReference.js';
+import MetadataTypes from '../lib/MetadataTypeInfo.js';
 
 import { fileURLToPath } from 'node:url';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -191,6 +192,13 @@ export function getExpectedFile(mid, type, action, ext) {
  */
 export function mockSetup(isDeploy) {
     cache.clearCache();
+    // clear local caches
+    for (const type of Object.keys(MetadataTypes)) {
+        if (MetadataTypes[type].cache) {
+            // we rarely use a local cache in types which also needs to be reset
+            MetadataTypes[type].cache = {};
+        }
+    }
     // no need to execute this again if we ran it a 2nd time for deploy - already done in standard setup
     if (!isDeploy) {
         // reset all options to default

package/types/mcdev.d.js

@@ -385,6 +385,96 @@
  * @property {string} [downloadBUs] used by mcdev init to directly push to a remote
  */
 
+/**
+ * @typedef {object} FilterItem
+ * @property {number} categoryId folder id
+ * @property {string} [createdDate] -
+ * @property {string} customerKey key
+ * @property {string} destinationObjectId DE/List ID
+ * @property {1|2|3|4} destinationTypeId 1:SubscriberList, 2:DataExtension, 3:GroupWizard, 4:BehavioralData
+ * @property {string} filterActivityId ?
+ * @property {string} filterDefinitionId ObjectID of filterDefinition
+ * @property {string} modifiedDate -
+ * @property {string} name name
+ * @property {string} [description] -
+ * @property {string} sourceObjectId DE/List ID
+ * @property {null} resultGroupFolderId required for upsert; unknown purpose; set to null
+ * @property {null} resultGroupName required for upsert; unknown purpose; set to null
+ * @property {null} sourceId required for upsert; unknown purpose; set to null
+ * @property {1|2|3|4} sourceTypeId 1:SubscriberList, 2:DataExtension, 3:GroupWizard, 4:BehavioralData
+ * @property {1|2|3|4} [filterDefinitionSourceTypeId] seems to be a duplicate of sourceTypeId?
+ * @property {string} [resultDEDescription] description of destination DE
+ * @property {string} [resultDEName] name of destination DE
+ * @property {string} [resultDEKey] key of destination DE
+ * @property {number} statusId ?
+ * @property {string} [r__dataFilter_key] relationship to filterDefinition
+ * @property {string} [r__source_dataExtension_key] relationship to dataExtension source
+ * @property {string} [r__destination_dataExtension_key] relationship to dataExtension destination
+ * @property {string} [r__folder_Path] relationship to folder
+ * @typedef {Object.<string, FilterItem>} FilterMap
+ */
+
+/**
+ * /automation/v1/filterdefinitions/<id> (not used)
+ *
+ * @typedef {object} AutomationFilterDefinitionItem
+ * @property {string} id object id
+ * @property {string} key external key
+ * @property {string} createdDate -
+ * @property {number} createdBy user id
+ * @property {string} createdName -
+ * @property {string} [description] (omitted by API if empty)
+ * @property {string} modifiedDate -
+ * @property {number} modifiedBy user id
+ * @property {string} modifiedName -
+ * @property {string} name name
+ * @property {string} categoryId folder id
+ * @property {string} filterDefinitionXml from REST API defines the filter in XML form
+ * @property {1|2} derivedFromType 1:list/profile attributes/measures, 2: dataExtension
+ * @property {boolean} isSendable ?
+ */
+/**
+ * /email/v1/filters/filterdefinition/<id>
+ *
+ * @typedef {object} DataFilterItem
+ * @property {string} id object id
+ * @property {string} key external key
+ * @property {string} createdDate date
+ * @property {number} createdBy user id
+ * @property {string} createdName name
+ * @property {string} [description] (omitted by API if empty)
+ * @property {string} lastUpdated date
+ * @property {number} lastUpdatedBy user id
+ * @property {string} lastUpdatedName name
+ * @property {string} name name
+ * @property {string} categoryId folder id
+ * @property {string} filterDefinitionXml from REST API defines the filter in XML form
+ * @property {1|2} derivedFromType 1:list/profile attributes/measures, 2: dataExtension
+ * @property {string} derivedFromObjectId Id of DataExtension - present if derivedFromType=2
+ * @property {'DataExtension'|'SubscriberAttributes'} derivedFromObjectTypeName -
+ * @property {string} [derivedFromObjectName] name of DataExtension
+ * @property {boolean} isSendable ?
+ * @property {object} [c__filterDefinition] copied from SOAP API, defines the filter in readable form
+ * @property {FilterConditionSet} c__filterDefinition.ConditionSet -
+ * @property {string} [r__source_list_PathName] relationship to list source (if derivedFromType=1)
+ * @property {string} [r__source_dataExtension_key] relationship to dataExtension source (if derivedFromType=2)
+ */
+/**
+ * @typedef {object} FilterConditionSet
+ * @property {FilterCondition | FilterCondition[]} Condition -
+ * @property {FilterConditionSet} ConditionSet -
+ */
+/**
+ * @typedef {object} FilterCondition
+ * @property {'IsEmpty'|'IsNotEmpty'|'Equals'} Operator comparison operator (actually \@_Operator)
+ * @property {string} [ID] object id of field (actually \@_ID)
+ * @property {string} [Value] filter value to compare against
+ * @property {string} [r__dataExtensionField_name] name of field
+ */
+/**
+ * @typedef {Object.<string, DataFilterItem>} DataFilterMap
+ */
+
 /**
  * @typedef {object} AuthObject
  * @property {string} client_id client_id client_id for sfmc-sdk auth
@@ -673,4 +763,15 @@ complex
  * @property {string} [deColumn] for bulk-creation only: instead of an array in addresses, specify the name of a DE column/field here
  */
 
+/**
+ * @typedef {object} BuildFilter
+ * @property {BuildFilterKeys} [include] include key filters
+ * @property {BuildFilterKeys} [exclude] exclude key filters
+ */
+
+/**
+ * @typedef {object} BuildFilterKeys
+ * @property {Object.<"*"|SupportedMetadataTypes, string[]>} [key] object with keys representing metadata types ("*" for all types, or specific type names) and values being arrays of string patterns to match against
+ */
+
 export default {};