npm - mcdev - Versions diffs - 7.1.3 → 7.1.4 - Mend

mcdev 7.1.3 → 7.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (126) hide show

package/test/type.asset.test.js CHANGED Viewed

@@ -30,6 +30,7 @@ async function getActualJson(customerKey, type, subtype, buName = 'testBU') {
         );
     }
 }
 /**
  * gets file from Retrieve folder
  *
@@ -52,6 +53,7 @@ async function getActualFile(customerKey, type, subtype, ext, filename, buName =
         return null;
     }
 }
 /**
  * gets file from Template folder
  *
@@ -71,6 +73,7 @@ async function getActualTemplateJson(customerKey, type, subtype) {
         );
     }
 }
 /**
  * gets file from Template folder
  *
@@ -113,6 +116,7 @@ async function getActualDeployJson(customerKey, type, subtype, buName = 'testBU'
         );
     }
 }
 /**
  * gets file from Deploy folder
  *

package/test/type.folder.test.js ADDED Viewed

@@ -0,0 +1,97 @@
+import * as chai from 'chai';
+const assert = chai.assert;
+// const expect = chai.expect;
+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: folder', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+    describe('Deploy ================', () => {
+        it('Should create automation & dataExtension folders', async () => {
+            // prepare
+            testUtils.copyToDeploy('folder-deploy', 'folder');
+            await testUtils.copyFile(
+                'dataFolder/+retrieve-response.xml',
+                'dataFolder/retrieve-response.xml'
+            );
+            await testUtils.copyFile(
+                'dataFolder/+retrieve-QAA-response.xml',
+                'dataFolder/retrieve-QAA-response.xml'
+            );
+            const deployed = await handler.deploy('testInstance/testBU', ['folder']);
+            // THEN
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
+            // get results from cache
+            const cached = cache.getCache();
+            assert.equal(
+                cached.folder ? Object.keys(cached.folder).length : 0,
+                38,
+                'unexpected number of folders in cache'
+            );
+            // check what was deployed
+            assert.deepEqual(
+                deployed['testInstance/testBU']?.folder
+                    ? Object.values(deployed['testInstance/testBU']?.folder).map((f) => f.Path)
+                    : null,
+                [
+                    'Data Extensions/my',
+                    'Data Extensions/my/sub',
+                    'Data Extensions/my/sub/path',
+                    'Data Extensions/my/sub/path/subpath',
+                    'my automations/my',
+                    'my automations/my/sub',
+                    'my automations/my/sub/path',
+                    'my automations/my/sub/path/subpath',
+                ],
+                'unexpected deployed folders'
+            );
+            // get callouts
+            const createRestCallouts = testUtils.getRestCallout('post', '/email/v1/category', true);
+            // confirm created item
+            assert.deepEqual(
+                createRestCallouts,
+                [
+                    { parentCatId: 290937, name: 'my', catType: 'automations' },
+                    { parentCatId: 862100, name: 'sub', catType: 'automations' },
+                    { parentCatId: 862101, name: 'path', catType: 'automations' },
+                    { parentCatId: 862102, name: 'subpath', catType: 'automations' },
+                ],
+                'create-payload JSON was not equal expected'
+            );
+            const createSoapCallouts = testUtils.getSoapCallouts('Create', 'DataFolder');
+            // confirm created item
+            assert.deepEqual(
+                createSoapCallouts,
+                [
+                    '<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><Body><CreateRequest xmlns="http://exacttarget.com/wsdl/partnerAPI"><Objects xsi:type="DataFolder"><Name>my</Name><Description></Description><ContentType>dataextension</ContentType><IsActive>true</IsActive><IsEditable>true</IsEditable><AllowChildren>true</AllowChildren><ParentFolder><ID>2</ID></ParentFolder></Objects></CreateRequest></Body><Header><fueloauth xmlns="http://exacttarget.com">9999999</fueloauth></Header></Envelope>',
+                    '<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><Body><CreateRequest xmlns="http://exacttarget.com/wsdl/partnerAPI"><Objects xsi:type="DataFolder"><Name>sub</Name><Description></Description><ContentType>dataextension</ContentType><IsActive>true</IsActive><IsEditable>true</IsEditable><AllowChildren>true</AllowChildren><ParentFolder><ID>862001</ID></ParentFolder></Objects></CreateRequest></Body><Header><fueloauth xmlns="http://exacttarget.com">9999999</fueloauth></Header></Envelope>',
+                    '<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><Body><CreateRequest xmlns="http://exacttarget.com/wsdl/partnerAPI"><Objects xsi:type="DataFolder"><Name>path</Name><Description></Description><ContentType>dataextension</ContentType><IsActive>true</IsActive><IsEditable>true</IsEditable><AllowChildren>true</AllowChildren><ParentFolder><ID>862002</ID></ParentFolder></Objects></CreateRequest></Body><Header><fueloauth xmlns="http://exacttarget.com">9999999</fueloauth></Header></Envelope>',
+                    '<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><Body><CreateRequest xmlns="http://exacttarget.com/wsdl/partnerAPI"><Objects xsi:type="DataFolder"><Name>subpath</Name><Description></Description><ContentType>dataextension</ContentType><IsActive>true</IsActive><IsEditable>true</IsEditable><AllowChildren>true</AllowChildren><ParentFolder><ID>862003</ID></ParentFolder></Objects></CreateRequest></Body><Header><fueloauth xmlns="http://exacttarget.com">9999999</fueloauth></Header></Envelope>',
+                ],
+                'create-payload XL was not equal expected'
+            );
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                10,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+});

package/test/utils.js CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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

/package/test/resources/9999999/dataFolder/{retrieve-response-.xml → +retrieve-response.xml} RENAMED Viewed

File without changes