mcdev 7.6.3 → 7.7.1

package/test/type.journey.test.js

@@ -46,7 +46,7 @@ describe('type: journey', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                26,
+                27,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -131,7 +131,7 @@ describe('type: journey', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                22,
+                23,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -218,7 +218,11 @@ describe('type: journey', () => {
             return;
         });
 
-        it('Should not deploy --publish an already published transactional journey', async () => {
+        it('Should deploy --publish an already published transactional journey by first pausing it', async () => {
+            await testUtils.copyFile(
+                'interaction/v1/interactions/key_testExisting_temail/put-response-paused.json',
+                'interaction/v1/interactions/key_testExisting_temail/put-response.json'
+            );
             // WHEN
             handler.setOptions({ skipStatusCheck: true, publish: true });
             const deploy = await handler.deploy(
@@ -228,23 +232,48 @@ describe('type: journey', () => {
             );
 
             // THEN
-            assert.equal(process.exitCode, 1, 'deploy --publish should have thrown an error');
+            assert.equal(process.exitCode, 0, 'deploy --publish should not have thrown an error');
             // retrieve result
             assert.deepEqual(
                 Object.keys(deploy['testInstance/testBU']?.journey),
-                [],
+                ['testExisting_temail'],
                 'should have published the right journey'
             );
 
+            const pauseCallout = testUtils.getRestCallout(
+                'post',
+                '/interaction/v1/interactions/transactional/pause'
+            );
+            const resumeCallout = testUtils.getRestCallout(
+                'post',
+                '/interaction/v1/interactions/transactional/resume'
+            );
+
+            // confirm callouts
+            assert.deepEqual(
+                pauseCallout,
+                {
+                    definitionId: 'dsfdsafdsa-922c-4568-85a5-e5cc77efc3be',
+                },
+                'pauseCallout-payload JSON was not equal expected'
+            );
+            assert.deepEqual(
+                resumeCallout,
+                {
+                    definitionId: 'dsfdsafdsa-922c-4568-85a5-e5cc77efc3be',
+                },
+                'resumeCallout-payload JSON was not equal expected'
+            );
+
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                22,
+                60,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
 
-        it('Should deploy --publish a transactional journey', async () => {
+        it('Should update and publish a transactional journey', async () => {
             // WHEN
             handler.setOptions({ skipStatusCheck: true, publish: true });
             const deploy = await handler.deploy(
@@ -288,13 +317,70 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                57,
+                59,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
 
-        it('Should deploy --publish a journey by key (auto-picks latest version)', async () => {
+        it('Should create and publish a transactional journey', async () => {
+            // WHEN
+            handler.setOptions({ skipStatusCheck: true, publish: true });
+            const deploy = await handler.deploy(
+                'testInstance/testBU',
+                ['journey'],
+                ['testNew_temail_notPublished']
+            );
+
+            // THEN
+            assert.equal(process.exitCode, 0, 'deploy --publish should not have thrown an error');
+            // retrieve result
+            assert.deepEqual(
+                Object.keys(deploy['testInstance/testBU']?.journey),
+                ['testNew_temail_notPublished'],
+                'should have published the right journey'
+            );
+
+            // get callouts
+            const publishCallout = testUtils.getRestCallout(
+                'post',
+                '/interaction/v1/interactions/transactional/create'
+            );
+            // confirm callouts
+            assert.deepEqual(
+                publishCallout,
+                {
+                    definitionId: '4c39662b-7c47-4df4-8bd6-65f01c313e8c',
+                },
+                'publish-payload JSON was not equal expected'
+            );
+
+            // confirm transactionalEmail was downloaded
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_temail_notPublished', 'transactionalEmail'),
+                await testUtils.getExpectedJson('9999999', 'transactionalEmail', 'create-publish'),
+                'returned JSON was not equal expected'
+            );
+            // confirm journey was downloaded
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_temail_notPublished', 'journey'),
+                await testUtils.getExpectedJson(
+                    '9999999',
+                    'journey',
+                    'create-transactionaEmail-publish'
+                ),
+                'returned JSON was not equal expected'
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                59,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should update & publish a  multi-step journey by key (auto-picks latest version)', async () => {
             handler.setOptions({ skipStatusCheck: true, publish: true });
             // WHEN
             const deploy = await handler.deploy(
@@ -380,7 +466,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                26,
+                27,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -418,7 +504,7 @@ describe('type: journey', () => {
             // journey
             assert.deepEqual(
                 templatedItems.journey.map((item) => item.key),
-                ['{{{prefix}}}journey_Quicksend', '{{{prefix}}}journey_Multistep'],
+                ['{{{prefix}}}journey_Multistep', '{{{prefix}}}journey_Quicksend'],
                 'expected specific journeys to be templated'
             );
             // event
@@ -434,9 +520,9 @@ describe('type: journey', () => {
             assert.deepEqual(
                 templatedItems.dataExtension.map((item) => item.CustomerKey),
                 [
-                    '{{{prefix}}}journey_Quicksend',
-                    '{{{prefix}}}journey_Multistep',
                     '{{{prefix}}}DomainExclusion',
+                    '{{{prefix}}}journey_Multistep',
+                    '{{{prefix}}}journey_Quicksend',
                 ],
                 'expected specific dataExtensions to be templated'
             );
@@ -457,8 +543,8 @@ describe('type: journey', () => {
                 templatedItems.asset.map((item) => item.customerKey),
                 [
                     '{{{prefix}}}asset_htmlblock',
-                    '{{{prefix}}}htmlblock1',
                     '{{{prefix}}}htmlblock 3 spaces',
+                    '{{{prefix}}}htmlblock1',
                     '{{{prefix}}}htmlblock2',
                 ],
                 'expected specific assets to be templated'
@@ -568,7 +654,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                32,
+                33,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -603,7 +689,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                32,
+                33,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -638,7 +724,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                32,
+                33,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -701,7 +787,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                37,
+                38,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -755,7 +841,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                35,
+                36,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -1180,7 +1266,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                36,
+                37,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -1203,7 +1289,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                41,
+                42,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/type.script.test.js

@@ -402,9 +402,9 @@ describe('type: script', () => {
             assert.deepEqual(
                 templatedItems.asset.map((item) => item.customerKey),
                 [
-                    '{{{prefix}}}htmlblock1',
                     '{{{prefix}}}asset_htmlblock',
                     '{{{prefix}}}htmlblock 3 spaces',
+                    '{{{prefix}}}htmlblock1',
                     '{{{prefix}}}htmlblock2',
                 ],
                 'expected specific assets to be templated'

package/test/type.sendClassification.test.js

@@ -39,7 +39,7 @@ describe('type: sendClassification', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                3,
+                4,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -82,7 +82,7 @@ describe('type: sendClassification', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                6,
+                7,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -132,7 +132,7 @@ describe('type: sendClassification', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                3,
+                4,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/type.senderProfile.test.js

@@ -36,7 +36,7 @@ describe('type: senderProfile', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                4,
+                5,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -61,6 +61,26 @@ describe('type: senderProfile', () => {
                 4,
                 '4 senderProfiles expected'
             );
+            // check callouts
+            const createCallout = testUtils.getRestCallout(
+                'post',
+                '/messaging/v1/domainverification/'
+            );
+            assert.deepEqual(
+                createCallout,
+                { domain: 'joern.berkefeld.New@accenture.com' },
+                'unexecpted payload for create callout'
+            );
+            // confirm created domainVerification item
+            assert.deepEqual(
+                await testUtils.getActualJson(
+                    'joern.berkefeld.New@accenture.com',
+                    'domainVerification'
+                ),
+                await testUtils.getExpectedJson('9999999', 'domainVerification', 'create'),
+                'returned new-JSON was not equal expected for insert domainVerification'
+            );
+
             // confirm created item
             assert.deepEqual(
                 await testUtils.getActualJson('testNew_senderProfile', 'senderProfile'),
@@ -76,7 +96,7 @@ describe('type: senderProfile', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                7,
+                10,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -123,7 +143,7 @@ describe('type: senderProfile', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                4,
+                5,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -203,7 +223,7 @@ describe('type: senderProfile', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                10,
+                11,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -238,7 +258,7 @@ describe('type: senderProfile', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                10,
+                11,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -273,7 +293,7 @@ describe('type: senderProfile', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                10,
+                11,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/type.transactionalEmail.test.js

@@ -26,7 +26,7 @@ describe('type: transactionalEmail', () => {
             const result = cache.getCache();
             assert.equal(
                 result.transactionalEmail ? Object.keys(result.transactionalEmail).length : 0,
-                2,
+                3,
                 'unexpected number of transactionalEmail'
             );
             assert.deepEqual(
@@ -36,7 +36,7 @@ describe('type: transactionalEmail', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                13,
+                14,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -57,7 +57,7 @@ describe('type: transactionalEmail', () => {
             const result = cache.getCache();
             assert.equal(
                 result.transactionalEmail ? Object.keys(result.transactionalEmail).length : 0,
-                3,
+                4,
                 'unexpected number of transactionalEmails'
             );
             // confirm created item
@@ -75,7 +75,7 @@ describe('type: transactionalEmail', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                15,
+                16,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -137,7 +137,7 @@ describe('type: transactionalEmail', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                13,
+                14,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/type.triggeredSend.test.js

@@ -172,8 +172,8 @@ describe('type: triggeredSend', () => {
                 templatedItems.asset.map((item) => item.customerKey),
                 [
                     '{{{prefix}}}asset_htmlblock',
-                    '{{{prefix}}}htmlblock1',
                     '{{{prefix}}}htmlblock 3 spaces',
+                    '{{{prefix}}}htmlblock1',
                     '{{{prefix}}}htmlblock2',
                 ],
                 'expected specific assets to be templated'

package/test/utils.js

@@ -5,6 +5,7 @@ import { axiosInstance } from '../node_modules/sfmc-sdk/lib/util.js';
 import handler from '../lib/index.js';
 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 { fileURLToPath } from 'node:url';
@@ -187,6 +188,7 @@ export function getExpectedFile(mid, type, action, ext) {
  * @returns {void}
  */
 export function mockSetup(isDeploy) {
+    cache.clearCache();
     // 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
@@ -204,6 +206,7 @@ export function mockSetup(isDeploy) {
             errorLog: undefined,
             execute: undefined,
             filter: undefined,
+            fix: undefined,
             fixShared: undefined,
             fromRetrieve: undefined,
             json: undefined,
@@ -212,6 +215,8 @@ export function mockSetup(isDeploy) {
             matchName: undefined,
             noUpdate: undefined,
             publish: undefined,
+            purge: undefined,
+            range: undefined,
             referenceFrom: undefined,
             referenceTo: undefined,
             refresh: undefined,
@@ -246,6 +251,9 @@ export function mockSetup(isDeploy) {
         ),
         '.mcdevrc.json': fsmock.load(path.resolve(__dirname, 'mockRoot/.mcdevrc.json')),
         '.mcdev-auth.json': fsmock.load(path.resolve(__dirname, 'mockRoot/.mcdev-auth.json')),
+        '.mcdev-validations.js': fsmock.load(
+            path.resolve(__dirname, 'mockRoot/.mcdev-validations.js')
+        ),
         'boilerplate/config.json': fsmock.load(
             path.resolve(__dirname, '../boilerplate/config.json')
         ),

package/types/mcdev.d.js

@@ -641,4 +641,16 @@ complex
  * @typedef {Object.<string, validationRule>} validationRuleList key=rule name
  */
 
+/**
+ * @typedef {object} DomainVerificationItem
+ * @property {number} [enterpriseId] EID
+ * @property {number} [memberId] MID
+ * @property {string} [domain] domain or email address used in retrieve and create
+ * @property {string} [emailAddress] email address used in update call for isSendable field
+ * @property {'Verified'|'Pending'} [status] returned by retrieve
+ * @property {'SAP'|'UserDomain'|'PrivateDomain'|'RegisteredDomain'} [domainType] returned by retrieve and required for update call
+ * @property {boolean} isSendable automatically true upon creation. can be changed to false via update
+ * @property {string} [emailSendTime] e.g. ""2023-06-19T11:11:17.32""
+ */
+
 export default {};