mcdev 7.1.3 → 7.2.0

package/test/type.journey.test.js

@@ -26,8 +26,8 @@ describe('type: journey', () => {
             const result = cache.getCache();
             assert.equal(
                 result.journey ? Object.keys(result.journey).length : 0,
-                3,
-                'only 3 journeys expected'
+                4,
+                'unexpected number of journeys'
             );
             assert.deepEqual(
                 await testUtils.getActualJson('testExisting_journey_Quicksend', 'journey'),
@@ -46,7 +46,7 @@ describe('type: journey', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                23,
+                25,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -131,7 +131,7 @@ describe('type: journey', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                20,
+                21,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -258,7 +258,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                23,
+                25,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -431,7 +431,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                29,
+                31,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -466,7 +466,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                29,
+                31,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -501,7 +501,7 @@ describe('type: journey', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                29,
+                31,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -509,6 +509,70 @@ describe('type: journey', () => {
     });
 
     describe('Publish ================', () => {
+        it(`Should not publish a transactional journey by key that is already published`, async () => {
+            handler.setOptions({ skipStatusCheck: true });
+            // WHEN
+            const publish = await handler.publish(
+                'testInstance/testBU',
+                ['journey'],
+                ['testExisting_temail']
+            );
+            // THEN
+            assert.equal(process.exitCode, 1, 'publish should have thrown an error');
+
+            assert.deepEqual(
+                publish['testInstance/testBU']?.journey,
+                [],
+                'should have not have published any journey'
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                1,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
+        it('Should publish a transactional journey by key', async () => {
+            handler.setOptions({ skipStatusCheck: true });
+            // WHEN
+            const publish = await handler.publish(
+                'testInstance/testBU',
+                ['journey'],
+                ['testExisting_temail_notPublished']
+            );
+            // THEN
+            assert.equal(process.exitCode, 0, 'publish should not have thrown an error');
+            // retrieve result
+            assert.deepEqual(
+                publish['testInstance/testBU']?.journey,
+                ['testExisting_temail_notPublished'],
+                'should have published the right journey'
+            );
+
+            // get callouts
+            const publishCallout = testUtils.getRestCallout(
+                'post',
+                '/interaction/v1/interactions/transactional/create'
+            );
+            // confirm created item
+            assert.deepEqual(
+                publishCallout,
+                {
+                    definitionId: 'd4a900fe-3a8f-4cc5-9a49-81286e3e2cd2',
+                },
+                'publish-payload JSON was not equal expected'
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                33,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+
         it('Should publish a journey by key (auto-picks latest version)', async () => {
             handler.setOptions({ skipStatusCheck: true });
             // WHEN
@@ -535,7 +599,7 @@ describe('type: journey', () => {
             assert.deepEqual(
                 publishCallout,
                 await testUtils.getExpectedJson('9999999', 'journey', 'publish-callout'),
-                'create-payload JSON was not equal expected'
+                'publish-payload JSON was not equal expected'
             );
 
             assert.equal(
@@ -559,7 +623,7 @@ describe('type: journey', () => {
             // retrieve result
             assert.deepEqual(
                 publish['testInstance/testBU']?.journey,
-                ['id:3c3f4112-9b43-43ca-8a89-aa0375b2c1a2/1'],
+                ['testExisting_journey_Quicksend'],
                 'should have published the right journey'
             );
 
@@ -572,12 +636,11 @@ describe('type: journey', () => {
             assert.deepEqual(
                 publishCallout,
                 await testUtils.getExpectedJson('9999999', 'journey', 'publish-callout'),
-                'create-payload JSON was not equal expected'
+                'publish-payload JSON was not equal expected'
             );
-
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                1,
+                2,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -596,7 +659,7 @@ describe('type: journey', () => {
             // retrieve result
             assert.deepEqual(
                 publish['testInstance/testBU']?.journey,
-                ['id:3c3f4112-9b43-43ca-8a89-aa0375b2c1a2'],
+                ['testExisting_journey_Quicksend'],
                 'should have published the right journey'
             );
 
@@ -609,7 +672,7 @@ describe('type: journey', () => {
             assert.deepEqual(
                 publishCallout,
                 await testUtils.getExpectedJson('9999999', 'journey', 'publish-callout'),
-                'create-payload JSON was not equal expected'
+                'publish-payload JSON was not equal expected'
             );
 
             assert.equal(
@@ -651,12 +714,12 @@ describe('type: journey', () => {
             assert.deepEqual(
                 publishCallout,
                 await testUtils.getExpectedJson('9999999', 'journey', 'publish-callout'),
-                'create-payload JSON was not equal expected'
+                'publish-payload JSON was not equal expected'
             );
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                2,
+                3,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -693,12 +756,12 @@ describe('type: journey', () => {
             assert.deepEqual(
                 publishCallout,
                 await testUtils.getExpectedJson('9999999', 'journey', 'publish-callout'),
-                'create-payload JSON was not equal expected'
+                'publish-payload JSON was not equal expected'
             );
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                2,
+                3,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -735,12 +798,12 @@ describe('type: journey', () => {
             assert.deepEqual(
                 publishCallout,
                 await testUtils.getExpectedJson('9999999', 'journey', 'publish-callout'),
-                'create-payload JSON was not equal expected'
+                'publish-payload JSON was not equal expected'
             );
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                2,
+                3,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/type.transactionalEmail.test.js

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

package/test/utils.js

@@ -33,6 +33,21 @@ const authResources = File.readJsonSync(path.join(__dirname, './resources/auth.j
 export async function copyFile(from, to, mid = '9999999') {
     return File.copyFileSimple(`./test/resources/${mid}/${from}`, `./test/resources/${mid}/${to}`);
 }
+
+/**
+ * gets file from Retrieve folder
+ *
+ * @param {string} from source path (starting in bu folder)
+ * @param {string} to target path (starting in bu folder)
+ * @param {string} [mid] used when we need to test on ParentBU
+ * @param {string} [buName] used when we need to test on ParentBU
+ * @returns {void} -
+ */
+export function copyToDeploy(from, to, mid = '9999999', buName = 'testBU') {
+    console.log(`Copying ${from} to deploy folder`); // eslint-disable-line no-console
+    File.copySync(`./test/resources/${mid}/${from}`, `./deploy/testInstance/${buName}/${to}`);
+}
+
 /**
  * gets file from Retrieve folder
  *
@@ -61,6 +76,7 @@ export function getActualDoc(customerKey, type, buName = 'testBU') {
         'utf8'
     );
 }
+
 /**
  * gets file from Retrieve folder
  *
@@ -79,6 +95,7 @@ export async function getActualFile(customerKey, type, ext, buName = 'testBU') {
         return null;
     }
 }
+
 /**
  * gets file from Deploy folder
  *
@@ -92,6 +109,7 @@ export function getActualDeployJson(customerKey, type, buName = 'testBU') {
         `./deploy/testInstance/${buName}/${type}/${customerKey}.${type}-meta.json`
     );
 }
+
 /**
  * gets file from Deploy folder
  *
@@ -107,6 +125,7 @@ export function getActualDeployFile(customerKey, type, ext, buName = 'testBU') {
         'utf8'
     );
 }
+
 /**
  * gets file from Template folder
  *
@@ -117,6 +136,7 @@ export function getActualDeployFile(customerKey, type, ext, buName = 'testBU') {
 export function getActualTemplateJson(customerKey, type) {
     return File.readJSON(`./template/${type}/${customerKey}.${type}-meta.json`);
 }
+
 /**
  * gets file from Template folder
  *
@@ -128,6 +148,7 @@ export function getActualTemplateJson(customerKey, type) {
 export function getActualTemplateFile(customerKey, type, ext) {
     return File.readFile(`./template/${type}/${customerKey}.${type}-meta.${ext}`, 'utf8');
 }
+
 /**
  * gets file from resources folder which should be used for comparison
  *
@@ -139,6 +160,7 @@ export function getActualTemplateFile(customerKey, type, ext) {
 export function getExpectedJson(mid, type, action) {
     return File.readJSON(`./test/resources/${mid}/${type}/${action}-expected.json`);
 }
+
 /**
  * gets file from resources folder which should be used for comparison
  *
@@ -151,6 +173,7 @@ export function getExpectedJson(mid, type, action) {
 export function getExpectedFile(mid, type, action, ext) {
     return File.readFile(`./test/resources/${mid}/${type}/${action}-expected.${ext}`, 'utf8');
 }
+
 /**
  * setup mocks for API and FS
  *
@@ -267,6 +290,7 @@ export function mockReset() {
     fsmock.restore();
     apimock.restore();
 }
+
 /**
  * helper to return amount of api callouts
  *
@@ -280,6 +304,7 @@ export function getAPIHistoryLength(includeToken) {
     }
     return historyArr.filter((item) => item.url !== '/v2/token').length;
 }
+
 /**
  * helper to return api history
  *
@@ -288,13 +313,15 @@ export function getAPIHistoryLength(includeToken) {
 export function getAPIHistory() {
     return apimock.history;
 }
+
 /**
  *
  * @param {'patch'|'delete'|'post'|'get'|'put'} method http method
  * @param {string} url url without domain, end on % if you want to search with startsWith()
+ * @param {boolean} returnAll useful for post requests that often have multiple callouts with the same url
  * @returns {object} json payload of the request
  */
-export function getRestCallout(method, url) {
+export function getRestCallout(method, url, returnAll = false) {
     if (!apimock.history[method]?.length) {
         console.log(`${tWarn} No history for method ${method}.`); // eslint-disable-line no-console
         const methods = Object.keys(apimock.history)
@@ -304,9 +331,18 @@ export function getRestCallout(method, url) {
         return null;
     }
     const subset = apimock.history[method];
-    const myCallout = subset.find((item) =>
-        url.endsWith('%') ? item.url.startsWith(url.slice(0, -1)) : item.url === url
-    );
+
+    /**
+     * helper for filter/find
+     *
+     * @param {any} item history item
+     * @returns {boolean} if item matches
+     */
+    function findCallout(item) {
+        return url.endsWith('%') ? item.url.startsWith(url.slice(0, -1)) : item.url === url;
+    }
+
+    const myCallout = returnAll ? subset.filter(findCallout) : subset.find(findCallout);
     if (!myCallout) {
         console.error(`${tWarn} No callout found for ${method} ${url}`); // eslint-disable-line no-console
         const urls = [...new Set(subset.map((el) => el.url))].join('\n- ');
@@ -317,8 +353,9 @@ export function getRestCallout(method, url) {
         console.error(`Available unique urls in method ${method}:\n- ${urls}`); // eslint-disable-line no-console
         return null;
     }
-    return JSON.parse(myCallout.data);
+    return returnAll ? myCallout.map((el) => JSON.parse(el.data)) : JSON.parse(myCallout.data);
 }
+
 /**
  *
  * @param {'Schedule'|'Retrieve'|'Create'|'Update'|'Delete'|'Describe'|'Execute'} requestAction soap request types
@@ -349,6 +386,7 @@ export function getSoapCallouts(requestAction, objectType) {
     }
     return myCallout;
 }
+
 /**
  * helper to return most important fields for each api call
  *
@@ -366,6 +404,7 @@ export function getAPIHistoryDebug() {
         });
     return historyArr;
 }
+
 /**
  * helper to return most important fields for each api call
  *

package/types/mcdev.d.js

@@ -8,6 +8,7 @@
  * @property {string} [businessUnit] name of the BU to interact with
  * @property {string} [credential] name of the credential to interact with
  */
+
 /**
  * @typedef {Object.<string, string>} TemplateMap
  * @typedef {'asset'|'asset-archive'|'asset-asset'|'asset-audio'|'asset-block'|'asset-code'|'asset-document'|'asset-image'|'asset-message'|'asset-other'|'asset-rawimage'|'asset-template'|'asset-textfile'|'asset-video'|'attributeGroup'|'attributeSet'|'automation'|'campaign'|'contentArea'|'dataExtension'|'dataExtensionField'|'dataExtensionTemplate'|'dataExtract'|'dataExtractType'|'discovery'|'deliveryProfile'|'email'|'emailSend'|'event'|'fileLocation'|'fileTransfer'|'filter'|'folder'|'importFile'|'journey'|'list'|'mobileCode'|'mobileKeyword'|'mobileMessage'|'query'|'role'|'script'|'sendClassification'|'senderProfile'|'transactionalEmail'|'transactionalPush'|'transactionalSMS'|'triggeredSend'|'user'|'verification'} SupportedMetadataTypes
@@ -31,6 +32,7 @@
  * @property {CodeExtract[]} codeArr list of code snippets in this item
  * @property {string[]} subFolder mostly set to null, otherwise list of subfolders
  */
+
 /**
  * @typedef {object} CodeExtract
  * @property {string[]} subFolder mostly set to null, otherwise subfolders path split into elements
@@ -39,6 +41,7 @@
  * @property {string} content file content
  * @property {'base64'} [encoding] optional for binary files
  */
+
 /**
  * @typedef {object} QueryItem
  * @property {string} name name
@@ -59,6 +62,7 @@
  * @property {string} [queryDefinitionId] Object ID of query
  * @typedef {Object.<string, QueryItem>} QueryMap
  */
+
 /**
  * @typedef {object} ScriptItem
  * @property {string} name name
@@ -71,11 +75,13 @@
  * @property {string} r__folder_Path folder path in which this DE is saved
  * @typedef {Object.<string, ScriptItem>} ScriptMap
  */
+
 /**
  * @typedef {Object.<string, any>} AssetItem
  * @typedef {Object.<string, AssetItem>} AssetMap
  * @typedef {'archive'|'asset'|'audio'|'block'|'code'|'document'|'image'|'message'|'other'|'rawimage'|'template'|'textfile'|'video'} AssetSubType
  */
+
 /**
  * @typedef {object} DataExtensionFieldItem
  * @property {string} [ObjectID] id
@@ -93,9 +99,11 @@
  * @property {number|string} MaxLength field length
  * @property {string} Scale the number of places after the decimal that the field can hold; example: "0","1", ...
  */
+
 /**
  * @typedef {Object.<string, DataExtensionFieldItem>} DataExtensionFieldMap  key: name of field, value: DataExtensionFieldItem
  */
+
 /**
  * @typedef {object} DataExtensionItem
  * @property {string} CustomerKey key
@@ -126,9 +134,11 @@
  * @property {boolean} ResetRetentionPeriodOnImport ?
  * @property {boolean} [DeleteAtEndOfRetentionPeriod] true for retention policy allRecords
  */
+
 /**
  * @typedef {Object.<string, DataExtensionItem>} DataExtensionMap
  */
+
 /**
  * @typedef {object} UserDocument
  * @property {'User'|'Installed Package'|'Inactivated User'} TYPE -
@@ -170,10 +180,12 @@
  * @property {object} [SsoIdentity] -
  * @property {Array|object} [SsoIdentities] -
  */
+
 /**
  * @typedef {{before:UserDocument,after:UserDocument}} UserDocumentDiff
  * @typedef {Object.<string, UserDocument>} UserDocumentMap key=customer key
  */
+
 /**
  * @typedef {object} UserDocumentDocumentHelper
  * @property {string} ActiveFlagDocs docs: user.ActiveFlag === true ? '✓' : '-'
@@ -187,6 +199,7 @@
  * @property {string} IsLockedDocs docs: if the user cannot login
  * @typedef {UserDocument & UserDocumentDocumentHelper} UserDocumentDocument
  */
+
 /**
  * @typedef {object} AccountUserConfiguration
  * @property {object} Client wrapper
@@ -211,6 +224,7 @@
  * @property {number} [displayOrder] order within step; starts with 1 or higher number
  * @property {string} r__type see this.definition.activityTypeMapping
  */
+
 /**
  * @typedef {object}  AutomationStep
  * @property {string} name description
@@ -219,6 +233,7 @@
  * @property {number} [stepNumber] step iterator, automatically set during deployment
  * @property {AutomationActivity[]} activities -
  */
+
 /**
  * @typedef {object} AutomationSchedule REST format
  * @property {number} typeId equals schedule.scheduleTypeId; upsert endpoint requires scheduleTypeId. retrieve endpoint returns typeId
@@ -233,6 +248,7 @@
  * @property {any} [scheduledTime] ?
  * @property {string} [scheduledStatus] ?
  */
+
 /**
  * @typedef {object} AutomationScheduleSoap SOAP format
  * @property {string} [RecurrenceType] 'Minutely'|'Hourly'|'Daily'|'Weekly'|'Monthly'|'Yearly'
@@ -261,6 +277,7 @@
  * @property {'EndOn'|'EndAfter'} RecurrenceRangeType set to 'EndOn' if AutomationSchedule.icalRecur contains 'UNTIL'; otherwise to 'EndAfter'
  * @property {number} [Occurrences] only exists if RecurrenceRangeType=='EndAfter'
  */
+
 /**
  * @typedef {object} AutomationItem
  * @property {string} id Object Id
@@ -296,6 +313,7 @@
  * @property {string} [r__folder_Path] folder path
  * @property {string} [categoryId] holds folder ID, replaced with r__folder_Path during retrieve
  */
+
 /**
  * @typedef {object} VerificationItem
  * @property {string} dataVerificationDefinitionId ID / Key
@@ -331,6 +349,7 @@
  * @property {string} _businessUnit mcdev business unit name inside of _credential
  * @typedef {import('simple-git').DiffResultTextFile & McdevDeltaPkgItem} DeltaPkgItem
  */
+
 /**
  * @typedef {import('sfmc-sdk/util').RestError} RestError
  * @typedef {import('sfmc-sdk/util').SOAPError} SOAPError
@@ -368,30 +387,35 @@
 complex
  * @property {boolean} [QueryAllAccounts] all BUs or just one
  */
+
 /**
  * @typedef {object} SoapFilterSimple
  * @property {string} property field
  * @property {'equals'|'notEquals'|'isNull'|'isNotNull'|'greaterThan'|'lessThan'|'greaterThanOrEqual'|'lessThanOrEqual'|'between'|'IN'|'in'|'like'} simpleOperator various options
  * @property {string | number | boolean | string[] | number[]} [value] field value
  */
+
 /**
  * @typedef {object} SoapFilterComplex
  * @property {SoapSDKFilter} leftOperand string for simple or a new filter-object for complex
  * @property {'AND'|'OR'} logicalOperator various options
  * @property {SoapSDKFilter} rightOperand string for simple or a new filter-object for complex; omit for isNull and isNotNull
  */
+
 /**
  * @typedef {object} SoapSDKFilterSimple
  * @property {SoapFilterSimple["property"]} leftOperand string for simple or a new filter-object for complex
  * @property {SoapFilterSimple["simpleOperator"]} operator various options
  * @property {SoapFilterSimple["value"]} [rightOperand] string for simple or a new filter-object for complex; omit for isNull and isNotNull
  */
+
 /**
  * @typedef {object} SoapSDKFilterComplex
  * @property {SoapFilterComplex["leftOperand"]} leftOperand string for simple or a new filter-object for complex
  * @property {SoapFilterComplex["logicalOperator"]} operator various options
  * @property {SoapFilterComplex["rightOperand"]} rightOperand string for simple or a new filter-object for complex; omit for isNull and isNotNull
  */
+
 /**
  * @typedef {SoapSDKFilterSimple | SoapSDKFilterComplex} SoapSDKFilter
  */
@@ -414,6 +438,7 @@ complex
  * @property {'AND'|'OR'} logicalOperator various options
  * @property {SoapSDKFilter | AssetFilterSimple} [rightOperand] string for simple or a new filter-object for complex; omit for isNull and isNotNull
  */
+
 /**
  * @typedef {object} AssetFilterSimple
  * @property {string} property field
@@ -448,12 +473,14 @@ complex
  * @property {(ex:SDKError,message?:string)=>void} errorStack print error with trace message
  * @typedef {import('winston').Logger & McdevLogger} Logger
  */
+
 /**
  * @typedef {{id: number, key: string, name: string}} AssetItemSimple
  * @typedef {Object.<string, AssetItemSimple>} AssetItemSimpleMap
  * @typedef {Object.<number, AssetItemSimple>} AssetItemIdSimpleMap
  * @typedef {'id'|'key'|'name'} ContentBlockConversionTypes
  */
+
 /**
  * @typedef {object} ExplainType
  * @property {string} name readable name of type