mcdev 7.0.3 → 7.1.0

package/test/type.script.test.js

@@ -109,7 +109,7 @@ describe('type: script', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                3,
+                2,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -150,7 +150,7 @@ describe('type: script', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                3,
+                2,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -192,7 +192,7 @@ describe('type: script', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                3,
+                2,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -217,7 +217,7 @@ describe('type: script', () => {
                 .exist;
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                3,
+                2,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -261,7 +261,7 @@ describe('type: script', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                5,
+                4,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -312,7 +312,7 @@ describe('type: script', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                3,
+                2,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -364,11 +364,57 @@ describe('type: script', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                3,
+                2,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
+
+        it('Should create a script template via buildTemplate with --dependencies', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['script', 'asset']);
+
+            handler.setOptions({ dependencies: true, skipInteraction: true });
+
+            // GIVEN there is a template
+            const templatedItems = await handler.buildTemplate(
+                'testInstance/testBU',
+                'script',
+                ['testExisting_script_ampscript'],
+                'testSourceMarket'
+            );
+            // WHEN
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
+
+            assert.deepEqual(
+                Object.keys(templatedItems),
+                ['script', 'asset'],
+                'expected specific types to be templated'
+            );
+
+            // script
+            assert.equal(
+                templatedItems.script ? Object.keys(templatedItems.script).length : 0,
+                1,
+                'unexpected number of scripts templated'
+            );
+            assert.deepEqual(
+                templatedItems.script.map((item) => item.key),
+                ['{{{prefix}}}script_ampscript'],
+                'expected specific scripts to be templated'
+            );
+            // asset
+            assert.equal(
+                templatedItems.asset ? Object.keys(templatedItems.asset).length : 0,
+                3,
+                'unexpected number of assets templated'
+            );
+            assert.deepEqual(
+                templatedItems.asset.map((item) => item.customerKey),
+                ['{{{prefix}}}htmlblock1', '{{{prefix}}}asset_htmlblock', '{{{prefix}}}htmlblock2'],
+                'expected specific assets to be templated'
+            );
+        });
     });
 
     describe('Delete ================', () => {
@@ -434,7 +480,11 @@ describe('type: script', () => {
             // retrieve result
             assert.deepEqual(
                 replace['testInstance/testBU'].script,
-                ['testExisting_script_ampincluded', 'testExisting_script_mixed'],
+                [
+                    'testExisting_script_ampscript',
+                    'testExisting_script_ampincluded',
+                    'testExisting_script_mixed',
+                ],
                 'should have found the right scripts that need updating'
             );
             // get results from cache
@@ -482,7 +532,7 @@ describe('type: script', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                15,
+                8,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -548,7 +598,7 @@ describe('type: script', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                15,
+                8,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -619,7 +669,7 @@ describe('type: script', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                15,
+                8,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/type.senderProfile.test.js

@@ -128,6 +128,39 @@ describe('type: senderProfile', () => {
             );
             return;
         });
+
+        it('Should create a senderProfile template via buildTemplate with --dependencies', async () => {
+            // download first before we test buildTemplate
+            handler.setOptions({ dependencies: true, retrieve: true });
+
+            // GIVEN there is a template
+            const templatedItems = await handler.buildTemplate(
+                'testInstance/testBU',
+                'senderProfile',
+                ['testExisting_senderProfile'],
+                'testSourceMarket'
+            );
+            // WHEN
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
+
+            assert.deepEqual(
+                Object.keys(templatedItems),
+                ['senderProfile'],
+                'expected specific types to be templated'
+            );
+
+            // senderProfile
+            assert.equal(
+                templatedItems.senderProfile ? Object.keys(templatedItems.senderProfile).length : 0,
+                1,
+                'unexpected number of senderProfiles templated'
+            );
+            assert.deepEqual(
+                templatedItems.senderProfile.map((item) => item.CustomerKey),
+                ['{{{prefix}}}senderProfile'],
+                'expected specific senderProfiles to be templated'
+            );
+        });
     });
 
     describe('Delete ================', () => {
@@ -175,7 +208,7 @@ describe('type: senderProfile', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                13,
+                7,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -210,7 +243,7 @@ describe('type: senderProfile', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                13,
+                7,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -245,7 +278,7 @@ describe('type: senderProfile', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                13,
+                7,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/type.transactionalEmail.test.js

@@ -36,7 +36,7 @@ describe('type: transactionalEmail', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                12,
+                11,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -75,7 +75,7 @@ describe('type: transactionalEmail', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                14,
+                13,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -137,7 +137,7 @@ describe('type: transactionalEmail', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                12,
+                11,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

package/test/type.triggeredSend.test.js

@@ -36,7 +36,7 @@ describe('type: triggeredSend', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                12,
+                10,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -75,7 +75,7 @@ describe('type: triggeredSend', () => {
             // check number of API calls
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                14,
+                12,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -122,11 +122,80 @@ describe('type: triggeredSend', () => {
             );
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                12,
+                10,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
+
+        it('Should create a script template via buildTemplate with --dependencies', async () => {
+            // download first before we test buildTemplate
+
+            handler.setOptions({ dependencies: true, retrieve: true });
+
+            // GIVEN there is a template
+            const templatedItems = await handler.buildTemplate(
+                'testInstance/testBU',
+                'triggeredSend',
+                ['testExisting_triggeredSend', 'testExisting_triggeredSend_rcb'],
+                'testSourceMarket'
+            );
+            // WHEN
+            assert.equal(process.exitCode, 0, 'buildTemplate should not have thrown an error');
+
+            assert.deepEqual(
+                Object.keys(templatedItems),
+                ['triggeredSend', 'sendClassification', 'senderProfile', 'asset'],
+                'expected specific types to be templated'
+            );
+
+            // triggeredSend
+            assert.equal(
+                templatedItems.triggeredSend ? Object.keys(templatedItems.triggeredSend).length : 0,
+                2,
+                'unexpected number of triggeredSends templated'
+            );
+            assert.deepEqual(
+                templatedItems.triggeredSend.map((item) => item.CustomerKey),
+                ['{{{prefix}}}triggeredSend', '{{{prefix}}}triggeredSend_rcb'],
+                'expected specific triggeredSends to be templated'
+            );
+            // sendClassification
+            assert.equal(
+                templatedItems.sendClassification
+                    ? Object.keys(templatedItems.sendClassification).length
+                    : 0,
+                1,
+                'unexpected number of sendClassifications templated'
+            );
+            assert.deepEqual(
+                templatedItems.sendClassification.map((item) => item.CustomerKey),
+                ['{{{prefix}}}sendClassification'],
+                'expected specific sendClassifications to be templated'
+            );
+            // senderProfile
+            assert.equal(
+                templatedItems.senderProfile ? Object.keys(templatedItems.senderProfile).length : 0,
+                2,
+                'unexpected number of senderProfiles templated'
+            );
+            assert.deepEqual(
+                templatedItems.senderProfile.map((item) => item.CustomerKey),
+                ['{{{prefix}}}senderProfile', '{{{prefix}}}senderProfile_rcb'],
+                'expected specific senderProfiles to be templated'
+            );
+            // asset
+            assert.equal(
+                templatedItems.asset ? Object.keys(templatedItems.asset).length : 0,
+                3,
+                'unexpected number of assets templated'
+            );
+            assert.deepEqual(
+                templatedItems.asset.map((item) => item.customerKey),
+                ['{{{prefix}}}asset_htmlblock', '{{{prefix}}}htmlblock1', '{{{prefix}}}htmlblock2'],
+                'expected specific assets to be templated'
+            );
+        });
     });
 
     describe('Delete ================', () => {
@@ -187,7 +256,7 @@ describe('type: triggeredSend', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                24,
+                16,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -222,7 +291,7 @@ describe('type: triggeredSend', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                24,
+                16,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
@@ -257,7 +326,7 @@ describe('type: triggeredSend', () => {
 
             assert.equal(
                 testUtils.getAPIHistoryLength(),
-                24,
+                16,
                 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;

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(

package/test/utils.js

@@ -16,6 +16,17 @@ let apimock;
 import { handleSOAPRequest, handleRESTRequest, soapUrl, restUrl } from './resourceFactory.js';
 const authResources = File.readJsonSync(path.join(__dirname, './resources/auth.json'));
 
+/**
+ * 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
+ * @returns {Promise.<{status:'ok'|'skipped'|'failed', statusMessage:string, file:string}>} -
+ */
+export async function copyFile(from, to, mid = '9999999') {
+    return File.copyFileSimple(`./test/resources/${mid}/${from}`, `./test/resources/${mid}/${to}`);
+}
 /**
  * gets file from Retrieve folder
  *
@@ -150,25 +161,34 @@ export function mockSetup(isDeploy) {
             noLogFile: true,
             // reset
             api: undefined,
-            keySuffix: undefined,
+            autoMidSuffix: undefined,
             changeKeyField: undefined,
             changeKeyValue: undefined,
             commitHistory: undefined,
+            dependencies: undefined,
             errorLog: undefined,
             execute: undefined,
             filter: undefined,
             fixShared: undefined,
             fromRetrieve: undefined,
             json: undefined,
+            keySuffix: undefined,
             like: undefined,
-            noMidSuffix: undefined,
+            noUpdate: undefined,
+            publish: undefined,
+            referenceFrom: undefined,
+            referenceTo: undefined,
             refresh: undefined,
-            _runningTest: undefined,
+            retrieve: undefined,
             schedule: undefined,
+            skipDeploy: undefined,
             skipInteraction: undefined,
+            skipRetrieve: undefined,
+            skipStatusCheck: undefined,
+            _runningTest: undefined,
+            _welcomeMessageShown: undefined,
         });
     }
-    // @ts-expect-error somehow, MockAdapter does not expect type AxiosInstance
     apimock = new MockAdapter(axiosInstance, { onNoMatch: 'throwException' });
     // set access_token to mid to allow for autorouting of mock to correct resources
     apimock.onPost(authResources.success.url).reply((config) => {
@@ -280,7 +300,7 @@ export function getRestCallout(method, url) {
  * @param {string} [objectType] optionall filter requests by object
  * @returns {object[]} json payload of the requests
  */
-export function getSoapCallout(requestAction, objectType) {
+export function getSoapCallouts(requestAction, objectType) {
     const method = 'post';
     const url = '/Service.asmx';
     const subset = apimock.history[method];
@@ -290,10 +310,12 @@ export function getSoapCallout(requestAction, objectType) {
         // find soap requestst of the correct request type
         .filter((item) => item.headers.SOAPAction === requestAction)
         // find soap requestst of the correct request type
-        .filter(
-            (item) =>
-                !objectType ||
-                item.data.split('<ObjectType>')[1].split('</ObjectType>')[0] === objectType
+        .filter((item) =>
+            !objectType || item.data.includes('<ObjectType')
+                ? item.data.split('<ObjectType>')[1].split('</ObjectType>')[0] === objectType
+                : item.data.includes('<Objects xsi:type="')
+                  ? item.data.split('<Objects xsi:type="')[1].split('">')[0] === objectType
+                  : false
         )
         .map((item) => item.data);
     return myCallout;

package/tsconfig.json

@@ -1,7 +1,12 @@
 {
     // Change this to match your project
-    "include": ["lib/**/*"],
+    "include": ["lib/**/*.js", "types/**/*.js", "test/**/*.js"],
     "compilerOptions": {
+        "module": "nodenext",
+        "moduleResolution": "nodenext",
+        "checkJs": true,
+        "skipLibCheck": true,
+        "target": "es2022",
         // Tells TypeScript to read JS files, as
         // normally they are ignored as source files
         "allowJs": true,

package/{jsconfig.json → tsconfig.npmScripts.json}

@@ -2,7 +2,7 @@
     "include": ["lib/**/*.js", "types/**/*.js", "test/**/*.js"],
     "exclude": ["node_modules"],
     "compilerOptions": {
-        "module": "NodeNext",
+        "module": "nodenext",
         "moduleResolution": "nodenext",
         "target": "es2022",
         "checkJs": true,

package/tsconfig.precommit.json

@@ -0,0 +1,26 @@
+{
+    // Change this to match your project
+    "include": ["lib/**/*.js"],
+    "compilerOptions": {
+        "module": "nodenext",
+        "moduleResolution": "nodenext",
+        "target": "es2022",
+        "checkJs": true,
+        "skipLibCheck": true,
+        // Tells TypeScript to read JS files, as
+        // normally they are ignored as source files
+        "allowJs": true,
+        // Generate d.ts files
+        "declaration": true,
+        // This compiler run should
+        // only output d.ts files
+        "emitDeclarationOnly": true,
+        // Types should go into this directory.
+        // Removing this would place the .d.ts files
+        // next to the .js files
+        "outDir": "@types",
+        // go to js file when using IDE functions like
+        // "Go to Definition" in VSCode
+        "declarationMap": true
+    }
+}

package/types/mcdev.d.js

@@ -94,7 +94,7 @@
  * @property {string} Scale the number of places after the decimal that the field can hold; example: "0","1", ...
  */
 /**
- * @typedef {Object.<string, DataExtensionFieldItem>} DataExtensionFieldMap
+ * @typedef {Object.<string, DataExtensionFieldItem>} DataExtensionFieldMap  key: name of field, value: DataExtensionFieldItem
  */
 /**
  * @typedef {object} DataExtensionItem
@@ -156,7 +156,7 @@
  * @property {number} [Client.ID] EID e.g:7281698
  * @property {number} [Client.ModifiedBy] AccountUserID of user who last modified this user
  * @property {'User'|'Installed Package'} c__type -
- * @property {boolean|string} [IsLocked] (API only)
+ * @property {boolean} [IsLocked] (API only)
  * @property {boolean} [Unlock] used to unlock a user that has IsLocked === true
  * @property {boolean} c__IsLocked_readOnly copy of IsLocked
  * @property {string} c__TimeZoneName name of timezone
@@ -175,11 +175,17 @@
  * @typedef {Object.<string, UserDocument>} UserDocumentMap key=customer key
  */
 /**
- * @typedef {UserDocument & object} UserDocumentDocument
- * @property {boolean | string} ActiveFlag user.ActiveFlag === true ? '✓' : '-'
- * @property {boolean | string} IsAPIUser user.IsAPIUser === true ? '✓' : '-'
- * @property {boolean | string} MustChangePassword user.MustChangePassword === true ? '✓' : '-'
- * @property {number | string} DefaultBusinessUnit default MID; BUName after we resolved it
+ * @typedef {object} UserDocumentDocumentHelper
+ * @property {string} ActiveFlagDocs docs: user.ActiveFlag === true ? '✓' : '-'
+ * @property {string} IsAPIUserDocs docs: user.IsAPIUser === true ? '✓' : '-'
+ * @property {string} MustChangePasswordDocs docs: user.MustChangePassword === true ? '✓' : '-'
+ * @property {string} DefaultBusinessUnitDocs docs: default MID; BUName after we resolved it
+ * @property {string} RolesDocs docs: list of roles as concatenated string
+ * @property {string} AssociatedBusDocs docs: list of associated BUs as concatenated string
+ * @property {string | number} ModifiedBy docs: user name who last modified this user
+ * @property {string} TimeZoneName docs: name of timezone
+ * @property {string} IsLockedDocs docs: if the user cannot login
+ * @typedef {UserDocument & UserDocumentDocumentHelper} UserDocumentDocument
  */
 /**
  * @typedef {object} AccountUserConfiguration
@@ -326,16 +332,9 @@
  * @typedef {import('simple-git').DiffResultTextFile & McdevDeltaPkgItem} DeltaPkgItem
  */
 /**
- * @typedef {import('sfmc-sdk/auth').default} SDKauth
- * @typedef {import('sfmc-sdk/rest').default} SDKrest
- * @typedef {import('sfmc-sdk/soap').default} SDKsoap
  * @typedef {import('sfmc-sdk/util').RestError} RestError
  * @typedef {import('sfmc-sdk/util').SOAPError} SOAPError
  * @typedef {SOAPError & RestError} SDKError
- * @typedef {object} SDK
- * @property {SDKauth} auth SDKauth
- * @property {SDKrest} rest SDKrest
- * @property {SDKsoap} soap SDKsoap
  */
 
 /**
@@ -471,4 +470,30 @@ complex
  * @property {boolean} supports.retrieveAsTemplate can you retrieve & template in one step
  */
 
+/**
+ * @typedef {object} ListItem
+ * @property {object} [Client] wrapper
+ * @property {number} Client.ID owning BU's MID
+ * @property {string} [PartnerKey] not used
+ * @property {string} [CreatedDate] "2021-06-21T11:54:57.103"
+ * @property {string} [ModifiedDate] "2021-06-21T11:54:57.103"
+ * @property {number} [ID] unique identifier per BU
+ * @property {string} [ObjectID] not used
+ * @property {string} [CustomerKey] unique identifer per BU
+ * @property {string} [Path] customn field that tracks the exact directory path of the current folder including its own name
+ * @property {object} [ParentFolder] wrapper
+ * @property {number} ParentFolder.ID folder id of parent folder; 0 if current folder is already on top level
+ * @property {string} [ParentFolder.ObjectID] not used
+ * @property {string} [ParentFolder.Path] customn field that tracks the exact directory path of the current folder including its own name
+ * @property {string} Name folder name
+ * @property {string} [Description] deprecated option to describe the folder content
+ * @property {string} ContentType e.g. "shared_data"; see folder-subtypes for complete list
+ * @property {boolean} IsActive ?
+ * @property {boolean} IsEditable option to disable renaming/moving this folder via GUI
+ * @property {boolean} AllowChildren option to prevent creating subfolders via GUI
+ * @property {boolean} [_generated] helper flag for Deployer class to signal if the folder was auto-generated or manually placed
+ *
+ * @typedef {Object.<number, ListItem>} ListIdMap key=id
+ * @typedef {Object.<string, ListItem>} ListMap key=customer key
+ */
 export default {};