mcdev 5.2.0 → 6.0.0

package/test/utils.js

@@ -1,17 +1,20 @@
-const File = require('../lib/util/file');
-const path = require('node:path');
-const axios = require('axios');
-const MockAdapter = require('axios-mock-adapter');
-const auth = require('../lib/util/auth');
-const Util = require('../lib/util/util');
-const handler = require('../lib/index');
+import File from '../lib/util/file.js';
+import path from 'node:path';
+import MockAdapter from 'axios-mock-adapter';
+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 { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 // for some reason doesnt realize below reference
 // eslint-disable-next-line no-unused-vars
-const fsmock = require('mock-fs');
+import fsmock from 'mock-fs';
+
 let apimock;
-const authResources = require('./resources/auth.json');
-const resourceFactory = require('./resourceFactory');
+import { handleSOAPRequest, handleRESTRequest, soapUrl, restUrl } from './resourceFactory.js';
+const authResources = File.readJsonSync(path.join(__dirname, './resources/auth.json'));
 
 /**
  * gets file from Retrieve folder
@@ -21,8 +24,12 @@ const resourceFactory = require('./resourceFactory');
  * @param {string} [buName] used when we need to test on ParentBU
  * @returns {Promise.<string>} file in string form
  */
-exports.getActualJson = (customerKey, type, buName = 'testBU') =>
-    File.readJSON(`./retrieve/testInstance/${buName}/${type}/${customerKey}.${type}-meta.json`);
+export function getActualJson(customerKey, type, buName = 'testBU') {
+    return File.readJSON(
+        `./retrieve/testInstance/${buName}/${type}/${customerKey}.${type}-meta.json`
+    );
+}
+
 /**
  * gets file from Retrieve folder
  *
@@ -31,8 +38,9 @@ exports.getActualJson = (customerKey, type, buName = 'testBU') =>
  * @param {string} [buName] used when we need to test on ParentBU
  * @returns {string} file path
  */
-exports.getActualDoc = (customerKey, type, buName = 'testBU') =>
-    `./retrieve/testInstance/${buName}/${type}/${customerKey}.${type}-doc.md`;
+export function getActualDoc(customerKey, type, buName = 'testBU') {
+    return `./retrieve/testInstance/${buName}/${type}/${customerKey}.${type}-doc.md`;
+}
 /**
  * gets file from Retrieve folder
  *
@@ -41,8 +49,9 @@ exports.getActualDoc = (customerKey, type, buName = 'testBU') =>
  * @param {string} ext file extension
  * @returns {string} file path
  */
-exports.getActualFile = (customerKey, type, ext) =>
-    `./retrieve/testInstance/testBU/${type}/${customerKey}.${type}-meta.${ext}`;
+export function getActualFile(customerKey, type, ext) {
+    return `./retrieve/testInstance/testBU/${type}/${customerKey}.${type}-meta.${ext}`;
+}
 /**
  * gets file from Deploy folder
  *
@@ -51,8 +60,11 @@ exports.getActualFile = (customerKey, type, ext) =>
  * @param {string} [buName] used when we need to test on ParentBU
  * @returns {Promise.<string>} file in string form
  */
-exports.getActualDeployJson = (customerKey, type, buName = 'testBU') =>
-    File.readJSON(`./deploy/testInstance/${buName}/${type}/${customerKey}.${type}-meta.json`);
+export function getActualDeployJson(customerKey, type, buName = 'testBU') {
+    return File.readJSON(
+        `./deploy/testInstance/${buName}/${type}/${customerKey}.${type}-meta.json`
+    );
+}
 /**
  * gets file from Deploy folder
  *
@@ -61,8 +73,9 @@ exports.getActualDeployJson = (customerKey, type, buName = 'testBU') =>
  * @param {string} ext file extension
  * @returns {string} file path
  */
-exports.getActualDeployFile = (customerKey, type, ext) =>
-    `./deploy/testInstance/testBU/${type}/${customerKey}.${type}-meta.${ext}`;
+export function getActualDeployFile(customerKey, type, ext) {
+    return `./deploy/testInstance/testBU/${type}/${customerKey}.${type}-meta.${ext}`;
+}
 /**
  * gets file from Template folder
  *
@@ -70,8 +83,9 @@ exports.getActualDeployFile = (customerKey, type, ext) =>
  * @param {string} type of metadata
  * @returns {Promise.<string>} file in string form
  */
-exports.getActualTemplateJson = (customerKey, type) =>
-    File.readJSON(`./template/${type}/${customerKey}.${type}-meta.json`);
+export function getActualTemplateJson(customerKey, type) {
+    return File.readJSON(`./template/${type}/${customerKey}.${type}-meta.json`);
+}
 /**
  * gets file from Template folder
  *
@@ -80,9 +94,9 @@ exports.getActualTemplateJson = (customerKey, type) =>
  * @param {string} ext file extension
  * @returns {string} file path
  */
-exports.getActualTemplateFile = (customerKey, type, ext) =>
-    `./template/${type}/${customerKey}.${type}-meta.${ext}`;
-
+export function getActualTemplateFile(customerKey, type, ext) {
+    return `./template/${type}/${customerKey}.${type}-meta.${ext}`;
+}
 /**
  * gets file from resources folder which should be used for comparison
  *
@@ -91,8 +105,9 @@ exports.getActualTemplateFile = (customerKey, type, ext) =>
  * @param {string} action of SOAP request
  * @returns {Promise.<string>} file in string form
  */
-exports.getExpectedJson = (mid, type, action) =>
-    File.readJSON(path.join('test', 'resources', mid, type, action + '-expected.json'));
+export function getExpectedJson(mid, type, action) {
+    return File.readJSON(path.join('test', 'resources', mid, type, action + '-expected.json'));
+}
 /**
  * gets file from resources folder which should be used for comparison
  *
@@ -102,32 +117,30 @@ exports.getExpectedJson = (mid, type, action) =>
  * @param {string} ext file extension
  * @returns {string} file path
  */
-exports.getExpectedFile = (mid, type, action, ext) =>
-    path.join('test', 'resources', mid, type, action + '-expected.' + ext);
+export function getExpectedFile(mid, type, action, ext) {
+    return path.join('test', 'resources', mid, type, action + '-expected.' + ext);
+}
 /**
  * setup mocks for API and FS
  *
  * @param {boolean} [isDeploy] if true, will mock deploy folder
  * @returns {void}
  */
-
-exports.mockSetup = (isDeploy) => {
+export function mockSetup(isDeploy) {
     if (!isDeploy) {
         // no need to execute this again - already done in standard setup
         handler.setOptions({ debug: true, noLogFile: true });
     }
-    apimock = new MockAdapter(axios, { onNoMatch: 'throwException' });
+    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) => {
         authResources.success.response.access_token = JSON.parse(config.data).account_id;
         return [authResources.success.status, authResources.success.response];
     });
+    apimock.onPost(soapUrl).reply((config) => handleSOAPRequest(config));
     apimock
-        .onPost(resourceFactory.soapUrl)
-        .reply((config) => resourceFactory.handleSOAPRequest(config));
-    apimock
-        .onAny(new RegExp(`^${escapeRegExp(resourceFactory.restUrl)}`))
-        .reply((config) => resourceFactory.handleRESTRequest(config));
+        .onAny(new RegExp(`^${escapeRegExp(restUrl)}`))
+        .reply((config) => handleRESTRequest(config));
     const fsMockConf = {
         '.prettierrc': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.prettierrc')),
         '.eslintrc': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.eslintrc')),
@@ -162,14 +175,14 @@ exports.mockSetup = (isDeploy) => {
 
     // ! reset exitCode or else tests could influence each other; do this in mockSetup to to ensure correct starting value
     process.exitCode = 0;
-};
+}
 
 /**
  * resets mocks for API and FS
  *
  * @returns {void}
  */
-exports.mockReset = () => {
+export function mockReset() {
     // remove all options that might have been set by previous tests
     for (const key in Util.OPTIONS) {
         if (Object.prototype.hasOwnProperty.call(Util.OPTIONS, key)) {
@@ -180,46 +193,53 @@ exports.mockReset = () => {
     auth.clearSessions();
     fsmock.restore();
     apimock.restore();
-};
+}
 /**
  * helper to return amount of api callouts
  *
  * @param {boolean} [includeToken] if true, will include token calls in count
  * @returns {object} of API history
  */
-exports.getAPIHistoryLength = (includeToken) => {
+export function getAPIHistoryLength(includeToken) {
     const historyArr = Object.values(apimock.history).flat();
     if (includeToken) {
         return historyArr.length;
     }
     return historyArr.filter((item) => item.url !== '/v2/token').length;
-};
+}
 /**
  * helper to return api history
  *
  * @returns {object} of API history
  */
-exports.getAPIHistory = () => apimock.history;
+export function getAPIHistory() {
+    return apimock.history;
+}
 /**
  * helper to return most important fields for each api call
  *
  * @returns {object} of API history
  */
-function getAPIHistoryDebug() {
+export function getAPIHistoryDebug() {
     const historyArr = Object.values(apimock.history)
         .flat()
-        .map((item) => ({ url: item.url, data: item.data }));
+        .map((item) => {
+            const log = { method: item.method, url: item.url };
+            if (item.data) {
+                log.body = item.data;
+            }
+            return log;
+        });
     return historyArr;
 }
-exports.getAPIHistoryDebug = getAPIHistoryDebug;
 /**
  * helper to return most important fields for each api call
  *
  * @returns {void} of API history
  */
-exports.logAPIHistoryDebug = () => {
+export function logAPIHistoryDebug() {
     console.log(getAPIHistoryDebug()); // eslint-disable-line no-console
-};
+}
 
 /**
  * escapes string for regex

package/types/mcdev.d.js

@@ -1,4 +1,4 @@
-const SDK = require('sfmc-sdk');
+import SDK from 'sfmc-sdk';
 /**
  * @ignore
  * @typedef {object} BuObject
@@ -251,6 +251,20 @@ const SDK = require('sfmc-sdk');
  * @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
+ * @property {'IsEqualTo'|'IsLessThan'|'IsGreaterThan'|'IsOutsideRange'|'IsInsideRange'|'IsNotEqualTo'|'IsNotLessThan'|'IsNotGreaterThan'|'IsNotOutsideRange'|'IsNotInsideRange'} verificationType key
+ * @property {number} value1 used for all verificationTypes; lower value for IsOutsideRange, IsInsideRange, IsNotOutsideRange, IsNotInsideRange
+ * @property {number} value2 only used for IsOutsideRange, IsInsideRange, IsNotOutsideRange, IsNotInsideRange; otherwise set to 0
+ * @property {boolean} shouldStopOnFailure flag to stop automation if verification fails
+ * @property {boolean} shouldEmailOnFailure flag to send email if verification fails
+ * @property {string} notificationEmailAddress email address to send notification to; empty string if shouldEmailOnFailure=false
+ * @property {string} notificationEmailMessage email message to send; empty string if shouldEmailOnFailure=false
+ * @property {number} createdBy user id of creator
+ * @property {string} r__dataExtension_CustomerKey key of target data extension
+ */
+
 /**
  * @typedef {Object.<string, AutomationItem>} AutomationMap
  * @typedef {{metadata:AutomationMap,type:string}} AutomationMapObj
@@ -333,4 +347,4 @@ complex
  * @property {Function} errorStack (ex, msg) print error with trace message
  */
 
-module.exports = {};
+export default {};