mcdev 7.0.3 → 7.0.4

package/test/resources/9999999/interaction/v1/eventDefinitions/post_withSchema-response.json

@@ -0,0 +1,241 @@
+{
+    "id": "b9cb2b05-738d-4f49-b53d-28e3bbe52d12",
+    "type": "APIEvent",
+    "name": "testNew_event_withSchema",
+    "description": "created on deploy",
+    "createdDate": "0001-01-01T00:00:00",
+    "createdBy": 0,
+    "modifiedDate": "0001-01-01T00:00:00",
+    "modifiedBy": 0,
+    "mode": "Production",
+    "eventDefinitionKey": "testNew_event_withSchema",
+    "dataExtensionId": "4342972c-a43c-ef11-a5c8-5cba2c702db8",
+    "dataExtensionName": "testNew_event_withSchema - 2024-07-08T014814443",
+    "schema": {
+        "id": "4342972c-a43c-ef11-a5c8-5cba2c702db8",
+        "name": "testNew_event_withSchema - 2024-07-08T014814443",
+        "fields": [
+            {
+                "name": "ContactId",
+                "dataType": "Text",
+                "maxLength": "18",
+                "isNullable": false,
+                "isPrimaryKey": true,
+                "isDevicePreference": false
+            },
+            {
+                "name": "Type",
+                "dataType": "Text",
+                "maxLength": "50",
+                "isNullable": false,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "Status",
+                "dataType": "Text",
+                "maxLength": "50",
+                "isNullable": false,
+                "isPrimaryKey": true,
+                "isDevicePreference": false
+            },
+            {
+                "name": "Respondent",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "FirstName",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "LastName",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "PreferredLanguage",
+                "dataType": "Text",
+                "maxLength": "50",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "TouchPoint",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "Datestamp",
+                "dataType": "Date",
+                "isNullable": true,
+                "defaultValue": "GetDate()",
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "StartDate",
+                "dataType": "Date",
+                "isNullable": true,
+                "defaultValue": "",
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "EndDate",
+                "dataType": "Date",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "BroadcastedNotificationDate",
+                "dataType": "Date",
+                "isNullable": true,
+                "defaultValue": "",
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "FirstReminderDate",
+                "dataType": "Date",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "SecondReminderDate",
+                "dataType": "Date",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "Title",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "DisplayName",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "Text",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "Description",
+                "dataType": "Text",
+                "maxLength": "4000",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "Channel",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "FirstReminderChannel",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "SecondReminderChannel",
+                "dataType": "Text",
+                "maxLength": "256",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "Email",
+                "dataType": "Email",
+                "maxLength": "",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "ArticleOrTaskID",
+                "dataType": "Text",
+                "maxLength": "18",
+                "isNullable": false,
+                "isPrimaryKey": true,
+                "isDevicePreference": false
+            },
+            {
+                "name": "Points",
+                "dataType": "Number",
+                "maxLength": "",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "TaskType",
+                "dataType": "Text",
+                "maxLength": "255",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            },
+            {
+                "name": "TaskArea",
+                "dataType": "Text",
+                "maxLength": "255",
+                "isNullable": true,
+                "isPrimaryKey": false,
+                "isDevicePreference": false
+            }
+        ],
+        "sendableCustomObjectField": "ContactId",
+        "sendableSubscriberField": "_SubscriberKey",
+        "isPlatformObject": false
+    },
+    "filterDefinitionId": "00000000-0000-0000-0000-000000000000",
+    "arguments": {
+        "serializedObjectType": 11,
+        "eventDefinitionKey": "testNew_event_withSchema",
+        "eventDefinitionId": "b9cb2b05-738d-4f49-b53d-28e3bbe52d12",
+        "dataExtensionId": "00000000-0000-0000-0000-000000000000"
+    },
+    "metaData": {},
+    "interactionCount": 0,
+    "isVisibleInPicker": true,
+    "category": "Event",
+    "publishedInteractionCount": 0,
+    "automationId": "00000000-0000-0000-0000-000000000000"
+}

package/test/resources/9999999/interaction/v1/interactions/0175b971-71a3-4d8e-98ac-48121f3fbf4f/delete-response.txt

@@ -0,0 +1 @@
+0175b971-71a3-4d8e-98ac-48121f3fbf4f

package/test/type.asset.test.js

@@ -492,7 +492,6 @@ describe('type: asset', () => {
             assert.equal(process.exitCode, 0, 'resolveId should not have thrown an error');
             assert.deepEqual(
                 resolveIdJson,
-                // @ts-expect-error bad typing of assert.deepEqual
                 await testUtils.getExpectedJson('9999999', 'asset', 'resolveId-1295064-noPath'),
                 'returned response was not equal expected'
             );
@@ -521,7 +520,6 @@ describe('type: asset', () => {
             assert.equal(process.exitCode, 0, 'resolveId should not have thrown an error');
             assert.deepEqual(
                 resolveIdJson,
-                // @ts-expect-error bad typing of assert.deepEqual
                 await testUtils.getExpectedJson('9999999', 'asset', 'resolveId-1295064-withPath'),
                 'returned response was not equal expected'
             );
@@ -536,7 +534,6 @@ describe('type: asset', () => {
             // IMPORTANT: this will throw a false "TEST-ERROR" but our testing framework currently needs to not find the file to throw a 404
             assert.deepEqual(
                 resolveIdJson,
-                // @ts-expect-error bad typing of assert.deepEqual
                 await testUtils.getExpectedJson('9999999', 'asset', 'resolveId-1234-notFound'),
                 'returned response was not equal expected'
             );

package/test/type.automation.test.js

@@ -162,7 +162,7 @@ describe('type: automation', () => {
                 'five cached automation expected'
             );
 
-            // const scheduleCalloutList = testUtils.getSoapCallout('Schedule');
+            // const scheduleCalloutList = testUtils.getSoapCallouts('Schedule');
             // const objectIds = {
             //     testNew_automation: 'a8afb0e2-b00a-4c88-ad2e-1f7f8788c560',
             //     testExisting_automation: '08afb0e2-b00a-4c88-ad2e-1f7f8788c560',

package/test/type.dataExtension.test.js

@@ -27,8 +27,8 @@ describe('type: dataExtension', () => {
             const result = cache.getCache();
             assert.equal(
                 result.dataExtension ? Object.keys(result.dataExtension).length : 0,
-                5,
-                'only 5 dataExtension expected'
+                7,
+                'only 7 dataExtension expected'
             );
             assert.deepEqual(
                 await testUtils.getActualJson('testExisting_dataExtension', 'dataExtension'),
@@ -116,8 +116,8 @@ describe('type: dataExtension', () => {
             const result = cache.getCache();
             assert.equal(
                 result.dataExtension ? Object.keys(result.dataExtension).length : 0,
-                7,
-                '7 dataExtensions expected'
+                9,
+                '9 dataExtensions expected'
             );
             // insert
             assert.deepEqual(

package/test/type.event.test.js

@@ -1,13 +1,12 @@
 import * as chai from 'chai';
 const assert = chai.assert;
-// const expect = chai.expect;
+const expect = chai.expect;
 
 import chaiFiles from 'chai-files';
-// import cache from '../lib/util/cache.js';
+import cache from '../lib/util/cache.js';
 import * as testUtils from './utils.js';
 import handler from '../lib/index.js';
 chai.use(chaiFiles);
-// const file = chaiFiles.file;
 
 describe('type: event', () => {
     beforeEach(() => {
@@ -18,12 +17,192 @@ describe('type: event', () => {
         testUtils.mockReset();
     });
 
-    describe('Retrieve ================', () => {});
+    describe('Retrieve ================', () => {
+        it('Should retrieve a event', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['event']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.event ? Object.keys(result.event).length : 0,
+                4,
+                'only 4 event expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_event', 'event'),
+                await testUtils.getExpectedJson('9999999', 'event', 'get'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                4,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
 
     describe('Deploy ================', () => {
         beforeEach(() => {
             testUtils.mockSetup(true);
         });
+
+        it('Should create an event & dataExtension via schema', async () => {
+            // prepare
+            await testUtils.copyFile(
+                'interaction/v1/eventDefinitions/post_withSchema-response.json',
+                'interaction/v1/eventDefinitions/post-response.json'
+            );
+            await testUtils.copyFile(
+                'dataExtension/retrieve-createdViaEvent-response.xml',
+                'dataExtension/retrieve-response.xml'
+            );
+            await testUtils.copyFile(
+                'dataExtension/update-afterCreatedViaEvent-response.xml',
+                'dataExtension/update-response.xml'
+            );
+
+            await handler.deploy('testInstance/testBU', ['event'], ['testNew_event_withSchema']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.event ? Object.keys(result.event).length : 0,
+                5,
+                '5 events expected'
+            );
+            // get callouts
+            const createCallout = testUtils.getRestCallout(
+                'post',
+                '/interaction/v1/eventDefinitions/'
+            );
+            // confirm created item
+            assert.deepEqual(
+                createCallout,
+                await testUtils.getExpectedJson('9999999', 'event', 'post_withSchema-callout'),
+                'create-payload JSON was not equal expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_event_withSchema', 'event'),
+                await testUtils.getExpectedJson('9999999', 'event', 'post_withSchema'),
+                'returned new-JSON was not equal expected for insert event'
+            );
+            // confirm we changed the dataExtension key correctly
+            const updateCalloutDE = testUtils.getSoapCallouts('Update', 'DataExtension');
+            expect(updateCalloutDE[0]).to.equal(
+                await testUtils.getExpectedFile(
+                    '9999999',
+                    'dataExtension',
+                    'update-callout-afterCreatedViaEvent',
+                    'xml'
+                )
+            );
+
+            // confirm created dataExtension
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_event_withSchema', 'dataExtension'),
+                await testUtils.getExpectedJson(
+                    '9999999',
+                    'dataExtension',
+                    'retrieve_event_withSchema'
+                ),
+
+                'returned metadata was not equal expected'
+            );
+
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                14,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should create an event with pre-Existing dataExtension', async () => {
+            // prepare
+            await testUtils.copyFile(
+                'interaction/v1/eventDefinitions/post_withExistingDE-response.json',
+                'interaction/v1/eventDefinitions/post-response.json'
+            );
+
+            await handler.deploy(
+                'testInstance/testBU',
+                ['event'],
+                ['testNew_event_withExistingDE']
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.event ? Object.keys(result.event).length : 0,
+                5,
+                '5 events expected'
+            );
+            // get callouts
+            const createCallout = testUtils.getRestCallout(
+                'post',
+                '/interaction/v1/eventDefinitions/'
+            );
+            // confirm created item
+            assert.deepEqual(
+                createCallout,
+                await testUtils.getExpectedJson('9999999', 'event', 'post_withExistingDE-callout'),
+                'create-payload JSON was not equal expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_event_withExistingDE', 'event'),
+                await testUtils.getExpectedJson('9999999', 'event', 'post_withExistingDE'),
+                'returned new-JSON was not equal expected for insert event'
+            );
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                5,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should update an event', async () => {
+            await handler.deploy('testInstance/testBU', ['event'], ['testExisting_event']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.event ? Object.keys(result.event).length : 0,
+                4,
+                '4 events expected'
+            );
+            // get callouts
+            const updateCallout = testUtils.getRestCallout(
+                'put',
+                '/interaction/v1/eventDefinitions/%'
+            );
+            // confirm updated item
+            assert.deepEqual(
+                updateCallout,
+                await testUtils.getExpectedJson('9999999', 'event', 'put-callout'),
+                'update-payload JSON was not equal expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_event', 'event'),
+                await testUtils.getExpectedJson('9999999', 'event', 'put'),
+                'returned existing-JSON was not equal expected for update event'
+            );
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                5,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
     });
 
     describe('FixKeys ================', () => {
@@ -54,9 +233,111 @@ describe('type: event', () => {
         });
     });
 
-    describe('Templating ================', () => {});
+    describe('Templating ================', () => {
+        it('Should create a event template via retrieveAsTemplate and build it', async () => {
+            // GIVEN there is a template
+            const result = await handler.retrieveAsTemplate(
+                'testInstance/testBU',
+                'event',
+                ['testExisting_event'],
+                'testSourceMarket'
+            );
+            // WHEN
+            assert.equal(process.exitCode, 0, 'retrieveAsTemplate should not have thrown an error');
+            assert.equal(
+                result.event ? Object.keys(result.event).length : 0,
+                1,
+                'only one event expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_event', 'event'),
+                await testUtils.getExpectedJson('9999999', 'event', 'template'),
+                'returned template JSON of retrieveAsTemplate was not equal expected'
+            );
+            // THEN
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'event',
+                ['testExisting_event'],
+                'testTargetMarket'
+            );
+            assert.equal(process.exitCode, 0, 'buildDefinition should not have thrown an error');
+
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_event', 'event'),
+                await testUtils.getExpectedJson('9999999', 'event', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
 
-    describe('Delete ================', () => {});
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                4,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should create a event template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['event']);
+            // GIVEN there is a template
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'event',
+                ['testExisting_event'],
+                'testSourceMarket'
+            );
+            // WHEN
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
+
+            assert.equal(
+                result.event ? Object.keys(result.event).length : 0,
+                1,
+                'only one event expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_event', 'event'),
+                await testUtils.getExpectedJson('9999999', 'event', 'template'),
+                'returned template JSON of buildTemplate was not equal expected'
+            );
+            // THEN
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'event',
+                ['testExisting_event'],
+                'testTargetMarket'
+            );
+            assert.equal(process.exitCode, 0, 'buildDefinition should not have thrown an error');
+
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testTemplated_event', 'event'),
+                await testUtils.getExpectedJson('9999999', 'event', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                4,
+                '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',
+                'event',
+                'testExisting_event'
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'deleteByKey should not have thrown an error');
+            assert.equal(isDeleted, true, 'deleteByKey should have returned true');
+            return;
+        });
+    });
 
     describe('CI/CD ================', () => {});
 });

package/test/type.journey.test.js

@@ -278,6 +278,19 @@ describe('type: journey', () => {
             assert.equal(isDeleted, true, 'should have deleted the item');
             return;
         });
+
+        it('Should delete 2 items with version', async () => {
+            // WHEN
+            const isDeleted = await handler.deleteByKey('testInstance/testBU', 'journey', [
+                'testExisting_journey_Quicksend/1',
+                'testExisting_journey_Multistep/1',
+            ]);
+            // THEN
+            assert.equal(process.exitCode, 0, 'delete should not have thrown an error');
+
+            assert.equal(isDeleted, true, 'should have deleted the item');
+            return;
+        });
     });
 
     describe('ReplaceContentBlockByX ================', () => {

package/test/type.user.test.js

@@ -55,7 +55,7 @@ describe('type: user', () => {
                 await File.readFile(`./docs/user/testInstance.users.md`, {
                     encoding: 'utf8',
                 })
-            ).replaceAll(regexFindDaysSinceLogin, [expectedDaysSinceLogin[0]]);
+            ).replaceAll(regexFindDaysSinceLogin, expectedDaysSinceLogin[0]);
             expect(actualFile).to.equal(expectedFile);
 
             assert.equal(