sfmc-sdk 0.5.0 → 0.6.1

package/lib/auth.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const axios = require('axios');
-const { isConnectionError } = require('./util');
+const { isConnectionError, RestError } = require('./util');
 const AVAIALABLE_SCOPES = [
     'accounts_read',
     'accounts_write',
@@ -154,21 +154,21 @@ module.exports = class Auth {
         }
         if (Boolean(forceRefresh) || _isExpired(this.authObject)) {
             try {
+                remainingAttempts--;
                 this.authObject = await _requestToken(this.authObject);
             } catch (ex) {
                 if (
                     this.options.retryOnConnectionError &&
-                    remainingAttempts &&
+                    remainingAttempts > 0 &&
                     isConnectionError(ex.code)
                 ) {
                     if (this.options?.eventHandlers?.onConnectionError) {
                         this.options.eventHandlers.onConnectionError(ex, remainingAttempts);
                     }
-                    remainingAttempts--;
                     return this.getAccessToken(forceRefresh, remainingAttempts);
-                } else {
-                    throw ex;
                 }
+
+                throw new RestError(ex);
             }
 
             if (this.options?.eventHandlers?.onRefresh) {
@@ -180,6 +180,7 @@ module.exports = class Auth {
 
     /**
      * Helper to get back list of scopes supported by SDK
+     *
      * @returns {Array[String]} array of potential scopes
      */
     getSupportedScopes() {

package/lib/rest.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const axios = require('axios');
-const { isObject, isConnectionError } = require('./util');
+const { isObject, isPayload, isConnectionError, RestError } = require('./util');
 const pLimit = require('p-limit');
 
 module.exports = class Rest {
@@ -175,23 +175,35 @@ module.exports = class Rest {
             requestOptions.headers = {
                 Authorization: `Bearer ` + this.auth.authObject.access_token,
             };
-            const res = await axios(requestOptions);
-            return res.data;
+            remainingAttempts--;
+            if (this.options?.eventHandlers?.logRequest) {
+                this.options.eventHandlers.logRequest(requestOptions);
+            }
+            const response = await axios(requestOptions);
+            if (this.options?.eventHandlers?.logResponse) {
+                this.options.eventHandlers.logResponse({
+                    data: response.data,
+                    status: response.status,
+                });
+            }
+            return response.data;
         } catch (ex) {
             if (
                 this.options.retryOnConnectionError &&
-                remainingAttempts &&
+                remainingAttempts > 0 &&
                 isConnectionError(ex.code)
             ) {
-                remainingAttempts--;
+                if (this.options?.eventHandlers?.onConnectionError) {
+                    this.options.eventHandlers.onConnectionError(ex, remainingAttempts);
+                }
                 return this._apiRequest(requestOptions, remainingAttempts);
             } else if (ex.response && ex.response.status === 401 && remainingAttempts) {
                 // force refresh due to url related issue
                 await this.auth.getAccessToken(true);
                 //only retry once on refresh since there should be no reason for this token to be invalid
-                return this._apiRequest(requestOptions, 0);
+                return this._apiRequest(requestOptions, 1);
             } else {
-                throw ex;
+                throw new RestError(ex);
             }
         }
     }
@@ -202,7 +214,7 @@ module.exports = class Rest {
  * @param {object} options API request opptions
  */
 function _checkPayload(options) {
-    if (!isObject(options.data)) {
+    if (!isPayload(options.data)) {
         throw new Error(`${options.method} requests require a payload in options.data`);
     }
 }

package/lib/soap.js

@@ -1,7 +1,8 @@
 'use strict';
 const axios = require('axios');
 const { XMLBuilder, XMLParser } = require('fast-xml-parser');
-const { isObject, isConnectionError } = require('./util');
+
+const { isObject, isConnectionError, SOAPError } = require('./util');
 
 module.exports = class Soap {
     /**
@@ -96,6 +97,8 @@ module.exports = class Soap {
             }
             status = resultsBatch.OverallStatus;
             if (status === 'MoreDataAvailable') {
+                //as requestParams is by default optional, ensure object exists in this case
+                requestParams = requestParams || {};
                 requestParams.continueRequest = resultsBatch.RequestID;
                 if (this.options?.eventHandlers?.onLoop) {
                     this.options.eventHandlers.onLoop(type, resultsBulk);
@@ -367,22 +370,25 @@ module.exports = class Soap {
             this.options.eventHandlers.logRequest(requestOptions);
         }
         let response;
+        remainingAttempts--;
         try {
             response = await axios(requestOptions);
         } catch (ex) {
             if (
                 this.options.retryOnConnectionError &&
-                remainingAttempts &&
+                remainingAttempts > 0 &&
                 isConnectionError(ex.code)
             ) {
-                remainingAttempts--;
+                if (this.options?.eventHandlers?.onConnectionError) {
+                    this.options.eventHandlers.onConnectionError(ex, remainingAttempts);
+                }
                 return this._apiRequest(options, remainingAttempts);
             } else if (ex.response) {
                 // if the response is received, then continue parsing and check for errors later
                 response = ex.response;
             } else {
                 // if no response, then throw
-                throw ex;
+                throw new SOAPError(ex);
             }
         }
         if (this.options?.eventHandlers?.logResponse) {
@@ -399,13 +405,17 @@ module.exports = class Soap {
             // need to wait as it may error
             return await _parseResponse(response, options.key);
         } catch (ex) {
-            if (ex.errorMessage === 'Token Expired' && remainingAttempts) {
+            if (ex.message === 'Token Expired' && remainingAttempts) {
                 // force refresh due to url related issue
                 await this.auth.getAccessToken(true);
                 // set to no more retries as after token refresh it should always work
-                return this._apiRequest(options, 0);
-            } else {
+                return this._apiRequest(options, 1);
+            } else if (ex instanceof SOAPError) {
+                //rethrow as is already handled/parsed
                 throw ex;
+            } else {
+                //unknown error
+                throw new SOAPError(ex, response, null);
             }
         }
     }
@@ -483,11 +493,12 @@ async function _parseResponse(response, key) {
         }
         // checks overall status error
         if (['Error', 'Has Errors'].includes(soapBody[key].OverallStatus)) {
-            throw new SOAPError(response, soapBody[key]);
+            throw new SOAPError(null, response, soapBody[key]);
         }
         return soapBody[key];
     }
-    throw new SOAPError(response, soapBody);
+    // something else went wrong but payload parsed
+    throw new SOAPError(null, response, soapBody);
 }
 /**
  * Method checks options object for validity
@@ -514,29 +525,3 @@ function validateOptions(options, additional) {
         }
     }
 }
-
-class SOAPError extends Error {
-    constructor(response, soapBody) {
-        // Content Error
-        if (soapBody && ['Error', 'Has Errors'].includes(soapBody.OverallStatus)) {
-            super('One or more errors in the Results');
-        }
-        // Payload Error
-        else if (soapBody && soapBody['soap:Fault']) {
-            super('Error in SOAP Payload');
-            const fault = soapBody['soap:Fault'];
-            this.errorCode = fault.faultcode;
-            this.errorMessage = fault.faultstring;
-        }
-        // Request Error
-        else if (response.status > 299) {
-            super('Error with SOAP Request');
-        }
-        // Fallback Error
-        else {
-            super('Unknown Error or Unhandled Request');
-        }
-        this.response = response;
-        this.JSON = soapBody;
-    }
-}

package/lib/util.js

@@ -6,6 +6,15 @@
  */
 module.exports.isObject = (obj) => Object.prototype.toString.call(obj) === '[object Object]';
 
+/**
+ * Method to check if Object passed is a valid payload for API calls
+ *
+ * @param {object} obj Object to check
+ * @returns {boolean} true if is a valid payload
+ */
+module.exports.isPayload = (obj) =>
+    Object.prototype.toString.call(obj) === '[object Object]' || Array.isArray(obj);
+
 /**
  * Method to check if it is a connection error
  *
@@ -14,3 +23,70 @@ module.exports.isObject = (obj) => Object.prototype.toString.call(obj) === '[obj
  */
 module.exports.isConnectionError = (code) =>
     code && ['ETIMEDOUT', 'EHOSTUNREACH', 'ENOTFOUND', 'ECONNRESET', 'ECONNABORTED'].includes(code);
+
+/**
+ * CustomError type for handling REST (including Auth) based errors
+ *
+ * @class RestError
+ * @augments {Error}
+ */
+module.exports.RestError = class RestError extends Error {
+    constructor(ex) {
+        // Expired Error
+        if (ex.response?.data?.message) {
+            super(ex.response.data.message);
+            this.code = ex.response.data.errorcode || ex.code;
+        }
+        // Unauthenticated
+        else if (ex.response?.data?.error_description) {
+            super(ex.response.data.error_description);
+            this.code = ex.response.data.error || ex.code;
+        } else {
+            super(ex.message);
+            this.code = ex.code;
+        }
+        this.response = ex.response;
+        this.name = this.constructor.name;
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, RestError);
+        }
+    }
+};
+
+/**
+ * CustomError type for handling SOAP based errors
+ *
+ * @class SOAPError
+ * @augments {Error}
+ */
+module.exports.SOAPError = class SOAPError extends Error {
+    constructor(ex, response, soapBody) {
+        // Content Error
+        if (soapBody && ['Error', 'Has Errors'].includes(soapBody.OverallStatus)) {
+            super('One or more errors in the Results');
+            this.code = soapBody.OverallStatus;
+        }
+        // Payload Error
+        else if (soapBody && soapBody['soap:Fault']) {
+            const fault = soapBody['soap:Fault'];
+            super(fault.faultstring);
+            this.code = fault.faultcode;
+        }
+        // Request Error
+        else if (response?.status > 299) {
+            super('Error with SOAP Request');
+            this.code = response?.status;
+        }
+        // Fallback Error
+        else {
+            super(ex.message);
+            this.code = ex.code;
+        }
+        this.response = response;
+        this.json = soapBody;
+        this.name = this.constructor.name;
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, SOAPError);
+        }
+    }
+};

package/package.json

@@ -1,46 +1,50 @@
 {
-    "name": "sfmc-sdk",
-    "version": "0.5.0",
-    "description": "Libarary to simplify SFMC requests with updated dependencies and less overhead",
-    "main": "./lib/index.js",
-    "scripts": {
-        "test": "nyc --reporter=text mocha",
-        "lint": "eslint ./lib",
-        "lint:fix": "eslint ./lib --fix"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/DougMidgley/SFMC-SDK.git"
-    },
-    "author": "Doug Midgley <douglasmidgley@gmail.com>",
-    "license": "BSD-3-Clause",
-    "dependencies": {
-        "axios": "^0.26.0",
-        "fast-xml-parser": "4.0.3",
-        "p-limit": "3.1.0"
-    },
-    "keywords": [
-        "fuel",
-        "exacttarget",
-        "salesforce",
-        "marketing",
-        "cloud",
-        "soap",
-        "rest",
-        "auth",
-        "sdk"
-    ],
-    "devDependencies": {
-        "assert": "2.0.0",
-        "axios-mock-adapter": "1.20.0",
-        "chai": "4.3.6",
-        "eslint-config-prettier": "8.4.0",
-        "eslint-plugin-jsdoc": "37.9.4",
-        "eslint-plugin-mocha": "10.0.3",
-        "eslint-plugin-prettier": "4.0.0",
-        "mocha": "9.2.1",
-        "nyc": "15.1.0",
-        "prettier-eslint": "13.0.0",
-        "sinon": "13.0.1"
-    }
+  "name": "sfmc-sdk",
+  "version": "0.6.1",
+  "description": "Libarary to simplify SFMC requests with updated dependencies and less overhead",
+  "main": "./lib/index.js",
+  "scripts": {
+    "test": "nyc --reporter=text mocha",
+    "lint": "eslint ./lib &&  eslint ./test",
+    "lint:fix": "eslint ./lib --fix && eslint ./test --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DougMidgley/SFMC-SDK.git"
+  },
+  "author": "Doug Midgley <douglasmidgley@gmail.com>",
+  "license": "BSD-3-Clause",
+  "dependencies": {
+    "axios": "^0.27.2",
+    "fast-xml-parser": "4.0.8",
+    "p-limit": "3.1.0"
+  },
+  "keywords": [
+    "fuel",
+    "exacttarget",
+    "salesforce",
+    "marketing",
+    "cloud",
+    "soap",
+    "rest",
+    "auth",
+    "sdk"
+  ],
+  "devDependencies": {
+    "assert": "2.0.0",
+    "axios-mock-adapter": "1.21.1",
+    "chai": "4.3.6",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-jsdoc": "39.3.3",
+    "eslint-plugin-mocha": "10.0.5",
+    "eslint-plugin-prettier": "4.0.0",
+    "mocha": "10.0.0",
+    "nyc": "15.1.0",
+    "prettier-eslint": "15.0.1",
+    "sinon": "14.0.0"
+  },
+  "engines": {
+    "npm": ">=6.14.4",
+    "node": ">=14.0.0"
+  }
 }

package/test/auth.test.js

@@ -4,11 +4,11 @@ const { defaultSdk, mock } = require('./utils.js');
 const resources = require('./resources/auth.json');
 const { isConnectionError } = require('../lib/util');
 
-describe('auth', () => {
-    afterEach(() => {
+describe('auth', function () {
+    afterEach(function () {
         mock.reset();
     });
-    it('should return an auth payload with token', async () => {
+    it('should return an auth payload with token', async function () {
         //given
         const { success } = resources;
 
@@ -20,7 +20,7 @@ describe('auth', () => {
         assert.lengthOf(mock.history.post, 1);
         return;
     });
-    it('should return an auth payload with previous token and one request', async () => {
+    it('should return an auth payload with previous token and one request', async function () {
         //given
         const { success } = resources;
         mock.onPost(success.url).reply(success.status, success.response);
@@ -33,7 +33,7 @@ describe('auth', () => {
         assert.lengthOf(mock.history.post, 1);
         return;
     });
-    it('should return an unauthorized error', async () => {
+    it('should return an unauthorized error', async function () {
         //given
         const { unauthorized } = resources;
         mock.onPost(unauthorized.url).reply(unauthorized.status, unauthorized.response);
@@ -49,10 +49,10 @@ describe('auth', () => {
 
         return;
     });
-    it('should return an incorrect account_id error', async () => {
+    it('should return an incorrect account_id error', async function () {
         try {
             //given
-            sfmc = new SDK({
+            new SDK({
                 client_id: 'XXXXX',
                 client_secret: 'YYYYYY',
                 auth_url: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.auth.marketingcloudapis.com/',
@@ -68,10 +68,10 @@ describe('auth', () => {
         }
         return;
     });
-    it('should return an incorrect auth_url error', async () => {
+    it('should return an incorrect auth_url error', async function () {
         try {
             //given
-            sfmc = new SDK({
+            new SDK({
                 client_id: 'XXXXX',
                 client_secret: 'YYYYYY',
                 auth_url: 'https://x.auth.marketingcloudapis.com/',
@@ -87,10 +87,10 @@ describe('auth', () => {
         }
         return;
     });
-    it('should return an incorrect client_id error', async () => {
+    it('should return an incorrect client_id error', async function () {
         try {
             //given
-            sfmc = new SDK({
+            new SDK({
                 client_id: '',
                 client_secret: 'YYYYYY',
                 auth_url: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.auth.marketingcloudapis.com/',
@@ -103,10 +103,10 @@ describe('auth', () => {
         }
         return;
     });
-    it('should return an incorrect client_key error', async () => {
+    it('should return an incorrect client_key error', async function () {
         try {
             //given
-            sfmc = new SDK({
+            new SDK({
                 client_id: 'XXXXX',
                 client_secret: '',
                 auth_url: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.auth.marketingcloudapis.com/',
@@ -119,10 +119,10 @@ describe('auth', () => {
         }
         return;
     });
-    it('should return an invalid scope error', async () => {
+    it('should return an invalid scope error', async function () {
         try {
             //given
-            sfmc = new SDK({
+            new SDK({
                 client_id: 'XXXXX',
                 client_secret: 'YYYYYY',
                 auth_url: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.auth.marketingcloudapis.com/',
@@ -136,10 +136,10 @@ describe('auth', () => {
         }
         return;
     });
-    it('should return an invalid scope type error', async () => {
+    it('should return an invalid scope type error', async function () {
         try {
             //given
-            sfmc = new SDK({
+            new SDK({
                 client_id: 'XXXXX',
                 client_secret: 'YYYYYY',
                 auth_url: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.auth.marketingcloudapis.com/',
@@ -154,7 +154,7 @@ describe('auth', () => {
         return;
     });
 
-    it('RETRY: should return an success, after a connection issues', async () => {
+    it('RETRY: should return an success, after a connection issues', async function () {
         //given
         const { success } = resources;
 
@@ -169,7 +169,7 @@ describe('auth', () => {
         assert.lengthOf(mock.history.post, 2);
         return;
     });
-    it('FAILED RETRY: should return an error, after multiple connection issues', async () => {
+    it('FAILED RETRY: should return an error, after multiple connection issues', async function () {
         //given
         const { success } = resources;
 

package/test/resources/auth.json

@@ -2,7 +2,7 @@
     "success": {
         "url": "https://mct0l7nxfq2r988t1kxfy8sc47ma.auth.marketingcloudapis.com/v2/token",
         "response": {
-            "access_token": "eyJhbGciOiJIUzI1NiIsImtpZCI6IjQiLCJ2ZXIiOiIxIiwidHlwIjoiSldUIn0.eyJhY2Nlc3NfdG9rZW4iOiI3UU9IYmJTd3JFOXRTYkdlTTQ4ZktXTXgiLCJjbGllbnRfaWQiOiIwbTBoZXQ2bXFrbnp2MHVlYnFsdm9vNDEiLCJlaWQiOjcyODE2OTgsInN0YWNrX2tleSI6IlM3IiwicGxhdGZvcm1fdmVyc2lvbiI6MiwiY2xpZW50X3R5cGUiOiJTZXJ2ZXJUb1NlcnZlciJ9.5TciRkgyCXpV232vUowRvGCR03-zT5d1NRBcZrIn1Z8.8_hnocm2nm2WkEu4KHNpyFrG60_TQ52XAVYmYSU8yyd452YL3Mzb6k_ieT9B2CWRI3dSvDARFK9bz59yjz1HWsUjP0ENXeyO6wEA8MpeVSkxlD6u6Q73ZtK2sAwsaFoSmx96HpjjhMWKxNEuESTl_Hp2Qfv_mXC2LNluVq3fYYKn7VSr4zaRTRB",
+            "access_token": "TESTTOKEN",
             "token_type": "Bearer",
             "expires_in": 1079,
             "scope": "offline documents_and_images_read documents_and_images_write saved_content_read saved_content_write automations_execute automations_read automations_write journeys_execute journeys_read journeys_write email_read email_send email_write push_read push_send push_write sms_read sms_send sms_write social_post social_publish social_read social_write web_publish web_read web_write audiences_read audiences_write list_and_subscribers_read list_and_subscribers_write data_extensions_read data_extensions_write file_locations_read file_locations_write tracking_events_read calendar_read calendar_write campaign_read campaign_write accounts_read accounts_write users_read users_write webhooks_read webhooks_write workflows_write approvals_write tags_write approvals_read tags_read workflows_read ott_chat_messaging_read ott_chat_messaging_send ott_channels_read ott_channels_write marketing_cloud_connect_read marketing_cloud_connect_write marketing_cloud_connect_send event_notification_callback_create event_notification_callback_read event_notification_callback_update event_notification_callback_delete event_notification_subscription_create event_notification_subscription_read event_notification_subscription_update event_notification_subscription_delete tracking_events_write key_manage_view key_manage_rotate key_manage_revoke dfu_configure journeys_aspr journeys_delete package_manager_package package_manager_deploy deep_linking_asset_read deep_linking_asset_write deep_linking_asset_delete deep_linking_settings_read deep_linking_settings_write",

package/test/resources/rest.json

@@ -356,6 +356,11 @@
             "serviceMessageID": "36f9ab27-aaee-46d5-b41f-4b7a61fc645a"
         }
     },
+    "dataExtensionUpsert": {
+        "status": 200,
+        "url": "https://mct0l7nxfq2r988t1kxfy8sc47ma.rest.marketingcloudapis.com/hub/v1/dataevents/key:key/rowset",
+        "response": [{ "keys": { "primaryKey": 1 }, "values": { "name": "test" } }]
+    },
     "campaignDelete": {
         "status": 200,
         "url": "https://mct0l7nxfq2r988t1kxfy8sc47ma.rest.marketingcloudapis.com/hub/v1/campaigns/12656",

package/test/rest.test.js

@@ -1,21 +1,21 @@
 const assert = require('chai').assert;
 const { defaultSdk, mock } = require('./utils.js');
+const SDK = require('../lib');
 const resources = require('./resources/rest.json');
 const authResources = require('./resources/auth.json');
 const { isConnectionError } = require('../lib/util');
 
-describe('rest', () => {
-    beforeEach(() => {
+describe('rest', function () {
+    beforeEach(function () {
         mock.onPost(authResources.success.url).reply(
             authResources.success.status,
             authResources.success.response
         );
     });
-    afterEach(() => {
+    afterEach(function () {
         mock.reset();
     });
-
-    it('GET Bulk: should return 6 journey items', async () => {
+    it('GET Bulk: should return 6 journey items', async function () {
         //given
         const { journeysPage1, journeysPage2 } = resources;
         mock.onGet(journeysPage1.url).reply(journeysPage1.status, journeysPage1.response);
@@ -28,7 +28,7 @@ describe('rest', () => {
         assert.lengthOf(mock.history.get, 2);
         return;
     });
-    it('GET: should return 5 journey items', async () => {
+    it('GET: should return 5 journey items', async function () {
         //given
         const { journeysPage1 } = resources;
         mock.onGet(journeysPage1.url).reply(journeysPage1.status, journeysPage1.response);
@@ -42,7 +42,7 @@ describe('rest', () => {
         assert.lengthOf(mock.history.get, 1);
         return;
     });
-    it('GETCOLLECTION: should return 2 identical payloads', async () => {
+    it('GETCOLLECTION: should return 2 identical payloads', async function () {
         //given
         const { journeysPage1 } = resources;
         mock.onGet(journeysPage1.url).reply(journeysPage1.status, journeysPage1.response);
@@ -58,7 +58,7 @@ describe('rest', () => {
         assert.lengthOf(mock.history.get, 2);
         return;
     });
-    it('POST: should create Event Definition', async () => {
+    it('POST: should create Event Definition', async function () {
         //given
         const { eventcreate } = resources;
         mock.onPost(eventcreate.url).reply(eventcreate.status, eventcreate.response);
@@ -91,7 +91,23 @@ describe('rest', () => {
         assert.lengthOf(mock.history.post, 2);
         return;
     });
-    it('PUT: should update Event Definition', async () => {
+    it('POST: should add an entry to a Data Extension', async function () {
+        //given
+        const { dataExtensionUpsert } = resources;
+        mock.onPost(dataExtensionUpsert.url).reply(
+            dataExtensionUpsert.status,
+            dataExtensionUpsert.response
+        );
+        // when
+        const payload = await defaultSdk().rest.post('hub/v1/dataevents/key:key/rowset', [
+            { keys: { primaryKey: 1 }, values: { name: 'test' } },
+        ]);
+        // then
+        assert.deepEqual(payload, dataExtensionUpsert.response);
+        assert.lengthOf(mock.history.post, 2);
+        return;
+    });
+    it('PUT: should update Event Definition', async function () {
         //given
         const { eventupdate } = resources;
         mock.onPut(eventupdate.url).reply(eventupdate.status, eventupdate.response);
@@ -114,7 +130,7 @@ describe('rest', () => {
         assert.lengthOf(mock.history.put, 1);
         return;
     });
-    it('PATCH: should update Contact', async () => {
+    it('PATCH: should update Contact', async function () {
         //given
         const { contactPatch } = resources;
         mock.onPatch(contactPatch.url).reply(contactPatch.status, contactPatch.response);
@@ -164,7 +180,7 @@ describe('rest', () => {
         assert.lengthOf(mock.history.patch, 1);
         return;
     });
-    it('DELETE: should delete Campaign', async () => {
+    it('DELETE: should delete Campaign', async function () {
         //given
         const { campaignDelete } = resources;
         mock.onDelete(campaignDelete.url).reply(campaignDelete.status, campaignDelete.response);
@@ -176,7 +192,7 @@ describe('rest', () => {
         assert.lengthOf(mock.history.delete, 1);
         return;
     });
-    it('should retry auth one time on first failure then work', async () => {
+    it('should retry auth one time on first failure then work', async function () {
         //given
         mock.reset(); // needed to avoid before hook being used
         const { expired, success } = authResources;
@@ -195,7 +211,7 @@ describe('rest', () => {
         assert.lengthOf(mock.history.delete, 1);
         return;
     });
-    it('should retry auth one time on first failure then fail', async () => {
+    it('should retry auth one time on first failure then fail', async function () {
         //given
         mock.reset(); // needed to avoid before hook being used
         const { unauthorized } = authResources;
@@ -214,7 +230,7 @@ describe('rest', () => {
         }
         return;
     });
-    it('should fail to delete campaign', async () => {
+    it('should fail to delete campaign', async function () {
         //given
         const { campaignFailed } = resources;
         mock.onDelete(campaignFailed.url).reply(campaignFailed.status, campaignFailed.response);
@@ -233,7 +249,7 @@ describe('rest', () => {
         assert.lengthOf(mock.history.delete, 1);
         return;
     });
-    it('RETRY: should return 5 journey items, after a connection error', async () => {
+    it('RETRY: should return 5 journey items, after a connection error', async function () {
         //given
         const { journeysPage1 } = resources;
         mock.onGet(journeysPage1.url)
@@ -250,7 +266,7 @@ describe('rest', () => {
         assert.lengthOf(mock.history.get, 2);
         return;
     });
-    it('FAILED RETRY: should return error, after 2 connection errors', async () => {
+    it('FAILED RETRY: should return error, after 2 connection timeout errors', async function () {
         //given
         const { journeysPage1 } = resources;
         mock.onGet(journeysPage1.url).timeout();
@@ -267,4 +283,75 @@ describe('rest', () => {
 
         return;
     });
+    it('FAILED RETRY: should return error, after 2 ECONNRESET errors', async function () {
+        //given
+        const { journeysPage1 } = resources;
+
+        mock.onGet(journeysPage1.url).reply(() => {
+            const connectionError = new Error();
+            connectionError.code = 'ECONNRESET';
+            throw connectionError;
+        });
+        // when
+        try {
+            await defaultSdk().rest.get('interaction/v1/interactions?$pageSize=5&$page=1');
+            assert.fail();
+        } catch (ex) {
+            // then
+            assert.isTrue(isConnectionError(ex.code));
+        }
+        assert.lengthOf(mock.history.post, 1);
+        assert.lengthOf(mock.history.get, 2);
+
+        return;
+    });
+    it('LogRequest & Response: should run middleware for logging ', async function () {
+        //given
+        const { journeysPage1 } = resources;
+        mock.onGet(journeysPage1.url).reply(journeysPage1.status, journeysPage1.response);
+        // when
+        let expectedRequest;
+        let expectedResponse;
+        const sdk = new SDK(
+            {
+                client_id: 'XXXXX',
+                client_secret: 'YYYYYY',
+                auth_url: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.auth.marketingcloudapis.com/',
+                account_id: 1111111,
+            },
+            {
+                eventHandlers: {
+                    logRequest: (reqObj) => {
+                        expectedRequest = reqObj;
+                    },
+
+                    logResponse: (resObj) => {
+                        expectedResponse = resObj;
+                    },
+                    onConnectionError: () => {
+                        return;
+                    },
+                },
+                retryOnConnectionError: true,
+                requestAttempts: 2,
+            }
+        );
+        // when
+        await sdk.rest.get('interaction/v1/interactions?$pageSize=5&$page=1');
+        // then
+        assert.deepEqual(
+            {
+                method: 'GET',
+                url: 'interaction/v1/interactions?$pageSize=5&$page=1',
+                baseURL: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.rest.marketingcloudapis.com/',
+                headers: {
+                    Authorization: 'Bearer TESTTOKEN',
+                },
+            },
+            expectedRequest
+        );
+        assert.equal(200, expectedResponse.status);
+        assert.equal(5, expectedResponse.data.items.length);
+        return;
+    });
 });

package/test/soap.test.js

@@ -19,18 +19,18 @@ const addHandler = (metadata) => {
     ).reply(metadata.status, metadata.response);
 };
 
-describe('soap', () => {
-    beforeEach(() => {
+describe('soap', function () {
+    beforeEach(function () {
         mock.onPost(authResources.success.url).reply(
             authResources.success.status,
             authResources.success.response
         );
     });
-    afterEach(() => {
+    afterEach(function () {
         mock.reset();
     });
 
-    it('retrieve: should return 1 data extension', async () => {
+    it('retrieve: should return 1 data extension', async function () {
         //given
         addHandler(resources.retrieveDataExtension);
         // when
@@ -56,7 +56,7 @@ describe('soap', () => {
         assert.lengthOf(mock.history.post, 2);
         return;
     });
-    it('retrieveBulk: should return 2 data extensions', async () => {
+    it('retrieveBulk: should return 2 data extensions', async function () {
         //given
         mock.onPost(
             '/Service.asmx',
@@ -102,7 +102,7 @@ describe('soap', () => {
         assert.lengthOf(mock.history.post, 3);
         return;
     });
-    it('failed: should fail to create 1 subscriber', async () => {
+    it('failed: should fail to create 1 subscriber', async function () {
         //given
         addHandler(resources.subscriberFailed);
         // when
@@ -122,13 +122,13 @@ describe('soap', () => {
             // then
             assert.fail();
         } catch (ex) {
-            assert.deepEqual(ex.JSON, resources.subscriberFailed.parsed);
+            assert.deepEqual(ex.json, resources.subscriberFailed.parsed);
             assert.lengthOf(mock.history.post, 2);
         }
 
         return;
     });
-    it('create: should create 1 subscriber', async () => {
+    it('create: should create 1 subscriber', async function () {
         //given
         addHandler(resources.subscriberCreated);
         // when
@@ -151,7 +151,7 @@ describe('soap', () => {
 
         return;
     });
-    it('update: should update 1 subscriber', async () => {
+    it('update: should update 1 subscriber', async function () {
         //given
         addHandler(resources.subscriberUpdated);
         // when
@@ -174,7 +174,7 @@ describe('soap', () => {
 
         return;
     });
-    it('expired: should return an error of expired token', async () => {
+    it('expired: should return an error of expired token', async function () {
         //given
         addHandler(resources.expiredToken);
         // when
@@ -185,13 +185,14 @@ describe('soap', () => {
             });
         } catch (ex) {
             // then
-            assert.equal(ex.errorMessage, 'Token Expired');
+            assert.equal(ex.message, 'Token Expired');
             assert.lengthOf(mock.history.post, 4);
+
             return;
         }
         assert.fail();
     });
-    it('bad Request: should return an error of bad request', async () => {
+    it('bad Request: should return an error of bad request', async function () {
         //given
         addHandler(resources.badRequest);
         // when
@@ -207,7 +208,7 @@ describe('soap', () => {
         }
         assert.fail();
     });
-    it('Delete: should delete a subscriber', async () => {
+    it('Delete: should delete a subscriber', async function () {
         //given
         addHandler(resources.subscriberDeleted);
         // when
@@ -219,7 +220,7 @@ describe('soap', () => {
         assert.lengthOf(mock.history.post, 2);
         return;
     });
-    it('Describe: should describe the subscriber type', async () => {
+    it('Describe: should describe the subscriber type', async function () {
         //given
         addHandler(resources.subscriberDescribed);
         // when
@@ -229,7 +230,7 @@ describe('soap', () => {
         assert.lengthOf(mock.history.post, 2);
         return;
     });
-    it('Execute: should unsubscribe subscriber', async () => {
+    it('Execute: should unsubscribe subscriber', async function () {
         //given
         addHandler(resources.subscribeUnsub);
         // when
@@ -242,7 +243,7 @@ describe('soap', () => {
         assert.lengthOf(mock.history.post, 2);
         return;
     });
-    it('Perform: should unsubscribe subscriber', async () => {
+    it('Perform: should unsubscribe subscriber', async function () {
         //given
         addHandler(resources.queryPerform);
         // when
@@ -254,7 +255,7 @@ describe('soap', () => {
         assert.lengthOf(mock.history.post, 2);
         return;
     });
-    it('Schedule: should schedule an Automation', async () => {
+    it('Schedule: should schedule an Automation', async function () {
         //given
         addHandler(resources.automationSchedule);
         // when
@@ -279,7 +280,7 @@ describe('soap', () => {
         assert.lengthOf(mock.history.post, 2);
         return;
     });
-    it('RETRY: should return 1 data extension, after a connection error', async () => {
+    it('RETRY: should return 1 data extension, after a connection error', async function () {
         //given
 
         mock.onPost('/Service.asmx')
@@ -322,7 +323,7 @@ describe('soap', () => {
         assert.lengthOf(mock.history.post, 3);
         return;
     });
-    it('FAILED RETRY: should return error, after multiple connection error', async () => {
+    it('FAILED RETRY: should return error, after multiple connection error', async function () {
         //given
 
         mock.onPost('/Service.asmx').timeout();

package/test/utils.js

@@ -113,7 +113,7 @@ exports.defaultSdk = () => {
                 },
             },
             retryOnConnectionError: true,
-            requestAttempts: 1,
+            requestAttempts: 2,
         }
     );
 };