sfmc-sdk 1.0.0 → 2.0.0

package/.github/workflows/codeql-analysis.yml

@@ -33,7 +33,7 @@ jobs:
 
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v2
+              uses: actions/checkout@v3
 
             # Initializes the CodeQL tools for scanning.
             - name: Initialize CodeQL

package/.github/workflows/prvalidation.yml

@@ -7,7 +7,7 @@ jobs:
     pr-labeler:
         runs-on: ubuntu-latest
         steps:
-            - uses: TimonVS/pr-labeler-action@v3
+            - uses: TimonVS/pr-labeler-action@v4
               with:
                   configuration-path: .github/pr-labeler.yml # optional, .github/pr-labeler.yml is the default value
               env:
@@ -16,10 +16,10 @@ jobs:
         runs-on: ubuntu-latest
 
         steps:
-            - uses: actions/checkout@v2
-            - uses: actions/setup-node@v2
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
               with:
-                  node-version: 16
+                  node-version: 18
                   registry-url: https://registry.npmjs.org/
             - run: npm install
             - run: npm run lint

package/.github/workflows/release.yml

@@ -15,12 +15,12 @@ jobs:
               id: create_release
               env:
                   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-            - uses: actions/checkout@v2
-            - uses: actions/setup-node@v2
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
               with:
-                  node-version: 16
+                  node-version: 18
                   registry-url: https://registry.npmjs.org/
-            - uses: HarmvZ/set-package-json-version-action@v0.1.2
+            - uses: HarmvZ/set-package-json-version-action@v0.2.5
               with:
                   version: ${{ steps.create_release.outputs.tag_name }}
             - run: npm i

package/lib/auth.js

@@ -1,6 +1,5 @@
 'use strict';
-const axios = require('axios');
-const { isConnectionError, RestError } = require('./util');
+import { isConnectionError, RestError, axiosInstance as axios } from './util.js';
 const AVAIALABLE_SCOPES = [
     'accounts_read',
     'accounts_write',
@@ -89,10 +88,12 @@ const AVAIALABLE_SCOPES = [
     'workflows_write',
 ];
 
-module.exports = class Auth {
+/**
+ * Class which handles authentication logic
+ */
+export default class Auth {
     /**
      * Creates an instance of Auth.
-     *
      * @param {object} authObject Auth Payload
      * @param {string} authObject.client_id Client Id from SFMC config
      * @param {string} authObject.client_secret Client Secret from SFMC config
@@ -179,13 +180,13 @@ module.exports = class Auth {
 
     /**
      * Helper to get back list of scopes supported by SDK
-     *
      * @returns {Array[String]} array of potential scopes
      */
     getSupportedScopes() {
         return AVAIALABLE_SCOPES;
     }
-};
+}
+
 /**
  * @param {object} authObject Auth object
  * @returns {boolean} true if token is expired

package/lib/index.js

@@ -1,16 +1,18 @@
 'use strict';
-const Auth = require('./auth');
-const Rest = require('./rest');
-const Soap = require('./soap');
+import Auth from './auth.js';
+import Rest from './rest.js';
+import Soap from './soap.js';
 
-module.exports = class SDK {
+/**
+ * Class main handler for the SDK
+ */
+export default class SDK {
     /**
      * Creates an instance of SDK.
-     *
      * @param {object} authObject Auth Object for making requests
      * @param {object} options options for the SDK as a whole, for example collection of handler functions, or retry settings
-     * @param {number} [options.requestAttempts=1] number of retries which should be done, defaulted to 1
-     * @param {boolean} [options.retryOnConnectionError=true] should request be retried in case of connection issues
+     * @param {number} [options.requestAttempts] number of retries which should be done, defaulted to 1
+     * @param {boolean} [options.retryOnConnectionError] should request be retried in case of connection issues
      * @param {object} [options.eventHandlers] collection of functions which are executed on certain events
      */
     constructor(authObject, options) {
@@ -27,4 +29,4 @@ module.exports = class SDK {
         this.rest = new Rest(this.auth, options);
         this.soap = new Soap(this.auth, options);
     }
-};
+}

package/lib/rest.js

@@ -1,12 +1,19 @@
 'use strict';
-const axios = require('axios');
-const { isObject, isPayload, isConnectionError, RestError } = require('./util');
-const pLimit = require('p-limit');
+import {
+    isObject,
+    isPayload,
+    isConnectionError,
+    RestError,
+    axiosInstance as axios,
+} from './util.js';
+import pLimit from 'p-limit';
 
-module.exports = class Rest {
+/**
+ * Class which handles rest endpoints
+ */
+export default class Rest {
     /**
      * Constuctor of Rest object
-     *
      * @function Object() { [native code] }
      * @param {object} authObject Auth object used for initializing
      * @param {object} options options for the SDK as a whole, for example collection of handler functions, or retry settings
@@ -23,7 +30,6 @@ module.exports = class Rest {
 
     /**
      * Method that makes the GET API request
-     *
      * @param {string} url of the resource to retrieve
      * @returns {Promise.<object>} API response
      */
@@ -37,8 +43,7 @@ module.exports = class Rest {
         );
     }
     /**
-     * helper for {@link getBulk} to determine if the url is a transactional message API
-     *
+     * helper for {@link this.getBulk} to determine if the url is a transactional message API
      * @private
      * @param {string} url url without query params
      * @returns {boolean} true if the url is a transactional message API
@@ -47,8 +52,7 @@ module.exports = class Rest {
         return url && this.transactionalApis.some((api) => url.includes(api));
     }
     /**
-     * helper for {@link getBulk} to determine if the url is a legacy API
-     *
+     * helper for {@link this.getBulk} to determine if the url is a legacy API
      * @private
      * @param {string} url url without query params
      * @returns {boolean} true if the url is a legacy API
@@ -58,7 +62,6 @@ module.exports = class Rest {
     }
     /**
      * Method that makes paginated GET API Requests using $pageSize and $page parameters
-     *
      * @param {string} url of the resource to retrieve
      * @param {number} [pageSize] of the response, defaults to 50
      * @param {string} [iteratorField] attribute of the response to iterate over (only required if it's not 'items'|'definitions'|'entry')
@@ -95,6 +98,8 @@ module.exports = class Rest {
                 },
                 this.options.requestAttempts
             );
+
+            // determine iterator field if not provided
             if (iteratorField && Array.isArray(responseBatch[iteratorField])) {
                 // if the iteratorField is set, use it
             } else if (Array.isArray(responseBatch.items)) {
@@ -106,26 +111,38 @@ module.exports = class Rest {
             } else {
                 throw new TypeError('Could not find an array to iterate over');
             }
+
+            // merge results with existing
             if (collector && Array.isArray(responseBatch[iteratorField])) {
                 collector[iteratorField].push(...responseBatch[iteratorField]);
             } else if (!collector) {
                 collector = responseBatch;
             }
+            // ! the transactional message API returns a value for "count" that represents the currently returned number of records, instead of the total amount. checking for count != pageSize is a workaround for this
+            // * opened Support Case #43988240 for this issue
             if (
-                Array.isArray(collector[iteratorField]) &&
-                collector[iteratorField].length >= responseBatch[countKey] &&
-                (!isTransactionalMessageApi ||
-                    (isTransactionalMessageApi &&
-                        responseBatch[countKey] != responseBatch[pageSizeKey]))
+                isTransactionalMessageApi &&
+                responseBatch[countKey] != responseBatch[pageSizeKey]
             ) {
-                // ! the transactional message API returns a value for "count" that represents the currently returned number of records, instead of the total amount. checking for count != pageSize is a workaround for this
-                // * opened Support Case #43988240 for this issue
                 shouldPaginate = false;
-            } else {
+            }
+            // if results are less than size, no more requested needed
+            else if (responseBatch[iteratorField].length < pageSize) {
+                shouldPaginate = false;
+            }
+            // stop if total amount is same as the current amount (all have been retrieved)
+            else if (collector[iteratorField].length >= responseBatch[countKey]) {
+                shouldPaginate = false;
+            }
+            // stop if response contains no results (for whatever reason) - this is a known issue on legacy API
+            else if (responseBatch[iteratorField].length === 0) {
+                shouldPaginate = false;
+            }
+            // otherwise loop
+            else {
                 page++;
                 shouldPaginate = true;
                 if (this.options?.eventHandlers?.onLoop) {
-                    // TODO in v1 change to undefined to ensure breaking changes considered
                     // eslint-disable-next-line unicorn/no-null
                     this.options.eventHandlers.onLoop(null, collector?.[iteratorField]);
                 }
@@ -135,9 +152,8 @@ module.exports = class Rest {
     }
     /**
      * Method that makes a GET API request for each URL (including rate limiting)
-     *
      * @param {string[]} urlArray of the resource to retrieve
-     * @param {number} [concurrentLimit=5] number of requests to execute at once
+     * @param {number} [concurrentLimit] number of requests to execute at once
      * @returns {Promise.<Array>} API response
      */
     async getCollection(urlArray, concurrentLimit) {
@@ -160,7 +176,6 @@ module.exports = class Rest {
     }
     /**
      * Method that makes the POST api request
-     *
      * @param {string} url of the resource to create
      * @param {object} payload for the POST request body
      * @returns {Promise.<object>} API response
@@ -176,7 +191,6 @@ module.exports = class Rest {
     }
     /**
      * Method that makes the PUT api request
-     *
      * @param {string} url of the resource to replace
      * @param {object} payload for the PUT request body
      * @returns {Promise.<object>} API response
@@ -192,7 +206,6 @@ module.exports = class Rest {
     }
     /**
      * Method that makes the PATCH api request
-     *
      * @param {string} url of the resource to update
      * @param {object} payload for the PATCH request body
      * @returns {Promise.<object>} API response
@@ -208,7 +221,6 @@ module.exports = class Rest {
     }
     /**
      * Method that makes the DELETE api request
-     *
      * @param {string} url of the resource to delete
      * @returns {Promise.<object>} API response
      */
@@ -224,7 +236,6 @@ module.exports = class Rest {
     }
     /**
      * Method that makes the api request
-     *
      * @param {object} requestOptions configuration for the request including body
      * @param {number} remainingAttempts number of times this request should be reattempted in case of error
      * @returns {Promise.<object>} Results from the Rest request in Object format
@@ -278,10 +289,10 @@ module.exports = class Rest {
             }
         }
     }
-};
+}
+
 /**
  * method to check if the payload is plausible and throw error if not
- *
  * @param {object} options API request opptions
  */
 function _checkPayload(options) {

package/lib/soap.js

@@ -1,13 +1,13 @@
 'use strict';
-const axios = require('axios');
-const { XMLBuilder, XMLParser } = require('fast-xml-parser');
+import { XMLBuilder, XMLParser } from 'fast-xml-parser';
+import { isObject, isConnectionError, axiosInstance as axios, SOAPError } from './util.js';
 
-const { isObject, isConnectionError, SOAPError } = require('./util');
-
-module.exports = class Soap {
+/**
+ * Class which handles SOAP endpoints
+ */
+export default class Soap {
     /**
      * Constuctor of Soap object
-     *
      * @function Object() { [native code] }
      * @param {object} auth Auth object used for initializing
      * @param {object} options options for the SDK as a whole, for example collection of handler functions, or retry settings
@@ -19,7 +19,6 @@ module.exports = class Soap {
 
     /**
      * Method used to retrieve data via SOAP API
-     *
      * @param {string} type - SOAP Object type
      * @param {string[]} properties - Properties which should be retrieved
      * @param {object} [requestParameters] - additional RetrieveRequest parameters, for example filter or options
@@ -80,7 +79,6 @@ module.exports = class Soap {
     }
     /**
      * Method used to retrieve all data via SOAP API
-     *
      * @param {string} type - SOAP Object type
      * @param {string[]} properties - Properties which should be retrieved
      * @param {object} [requestParameters] - additional RetrieveRequest parameters, for example filter or options
@@ -111,7 +109,6 @@ module.exports = class Soap {
     }
     /**
      * Method used to create data via SOAP API
-     *
      * @param {string} type - SOAP Object type
      * @param {string[]} properties - Properties which should be created
      * @param {object} [requestParameters] - additional RetrieveRequest parameters, for example filter or options
@@ -144,7 +141,6 @@ module.exports = class Soap {
     }
     /**
      * Method used to update data via SOAP API
-     *
      * @param {string} type - SOAP Object type
      * @param {string[]} properties - Properties which should be updated
      * @param {object} [requestParameters] - additional RetrieveRequest parameters, for example filter or options
@@ -178,7 +174,6 @@ module.exports = class Soap {
     }
     /**
      * Method used to delete data via SOAP API
-     *
      * @param {string} type - SOAP Object type
      * @param {string[]} properties - Properties which should be retrieved
      * @param {object} [requestParameters] - additional RetrieveRequest parameters, for example filter or options
@@ -211,7 +206,6 @@ module.exports = class Soap {
     }
     /**
      * Method used to schedule data via SOAP API
-     *
      * @param {string} type - SOAP Object type
      * @param {object} schedule - object for what the schedule should be
      * @param {Array | object} interactions - Object or array of interactions
@@ -253,7 +247,6 @@ module.exports = class Soap {
     }
     /**
      * Method used to describe metadata via SOAP API
-     *
      * @param {string} type - SOAP Object type
      * @returns {Promise.<object>} SOAP object converted from XML
      */
@@ -281,7 +274,6 @@ module.exports = class Soap {
     }
     /**
      * Method used to execute data via SOAP API
-     *
      * @param {string} type - SOAP Object type
      * @param {string[]} properties - Properties which should be retrieved
      * @returns {Promise.<object>} SOAP object converted from XML
@@ -309,7 +301,6 @@ module.exports = class Soap {
     }
     /**
      * Method used to execute data via SOAP API
-     *
      * @param {string} type - SOAP Object type
      * @param {string} action - type of action, for example 'Start'
      * @param {object} payload - relevant payload to perform, for example query Definition
@@ -349,7 +340,6 @@ module.exports = class Soap {
     }
     /**
      * Method used to configure data via SOAP API
-     *
      * @private
      * @param {string} type - SOAP Object type
      * @param {object[]} configArray - Properties which should be updated
@@ -385,7 +375,6 @@ module.exports = class Soap {
 
     /**
      * Method that makes the api request
-     *
      * @param {object} options configuration for the request including body
      * @param {number} remainingAttempts number of times this request should be reattempted in case of error
      * @returns {Promise.<object>} Results from the SOAP request in Object format
@@ -459,10 +448,10 @@ module.exports = class Soap {
             }
         }
     }
-};
+}
+
 /**
  * Method to build the payload then conver to XML
- *
  * @param {object} request Object form of the payload
  * @param {string} token access token for authentication
  * @returns {string} XML string payload
@@ -486,7 +475,6 @@ function _buildEnvelope(request, token) {
 
 /**
  * Method to filter requests in SOAP
- *
  * @param {object} filter Polymorphic filter object
  * @returns {object} formatted filter object
  */
@@ -519,7 +507,6 @@ function _parseFilter(filter) {
 }
 /**
  * Method to parse the XML response
- *
  * @param {string} response payload including whole SOAP response
  * @param {string} key key of the expected response body
  * @returns {Promise.<object | Error>} Result of request in Object format
@@ -547,7 +534,6 @@ async function _parseResponse(response, key) {
 }
 /**
  * Method checks options object for validity
- *
  * @param {object} options configuration for the request including body
  * @param {string[]} additional - additional keys which are acceptable
  */

package/lib/util.js

@@ -1,37 +1,40 @@
 'use strict';
 /**
  * Method to check if Object passed is a simple object
- *
  * @param {object} object Object to check
  * @returns {boolean} true if is simple Object
  */
-module.exports.isObject = (object) => Object.prototype.toString.call(object) === '[object Object]';
+export function isObject(object) {
+    return Object.prototype.toString.call(object) === '[object Object]';
+}
 
 /**
  * Method to check if Object passed is a valid payload for API calls
- *
  * @param {object} object Object to check
  * @returns {boolean} true if is a valid payload
  */
-module.exports.isPayload = (object) =>
-    Object.prototype.toString.call(object) === '[object Object]' || Array.isArray(object);
+export function isPayload(object) {
+    return Object.prototype.toString.call(object) === '[object Object]' || Array.isArray(object);
+}
 
 /**
  * Method to check if it is a connection error
- *
  * @param {string} code returned code from exception
  * @returns {boolean} true if a connection error
  */
-module.exports.isConnectionError = (code) =>
-    code && ['ETIMEDOUT', 'EHOSTUNREACH', 'ENOTFOUND', 'ECONNRESET', 'ECONNABORTED'].includes(code);
+export function isConnectionError(code) {
+    return (
+        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 {
+export class RestError extends Error {
     /**
      *
      * @param {Error} ex Error object
@@ -59,15 +62,14 @@ module.exports.RestError = class RestError extends Error {
             Error.captureStackTrace(this, RestError);
         }
     }
-};
+}
 
 /**
  * CustomError type for handling SOAP based errors
- *
  * @class SOAPError
  * @augments {Error}
  */
-module.exports.SOAPError = class SOAPError extends Error {
+export class SOAPError extends Error {
     /**
      *
      * @param {Error} ex Error object
@@ -113,4 +115,6 @@ module.exports.SOAPError = class SOAPError extends Error {
             Error.captureStackTrace(this, SOAPError);
         }
     }
-};
+}
+import axios from 'axios';
+export const axiosInstance = axios.create();

package/package.json

@@ -1,12 +1,12 @@
 {
     "name": "sfmc-sdk",
-    "version": "1.0.0",
+    "version": "2.0.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 &&  eslint ./test",
-        "lint:fix": "eslint ./lib --fix && eslint ./test --fix",
+        "lint": "eslint ./lib ./test",
+        "lint:fix": "eslint ./lib ./test --fix",
         "prepare": "husky install"
     },
     "repository": {
@@ -16,9 +16,9 @@
     "author": "Doug Midgley <douglasmidgley@gmail.com>",
     "license": "BSD-3-Clause",
     "dependencies": {
-        "axios": "^1.3.5",
-        "fast-xml-parser": "4.2.0",
-        "p-limit": "3.1.0"
+        "axios": "^1.4.0",
+        "fast-xml-parser": "4.2.2",
+        "p-limit": "4.0.0"
     },
     "keywords": [
         "fuel",
@@ -35,20 +35,21 @@
         "assert": "2.0.0",
         "axios-mock-adapter": "1.21.4",
         "chai": "4.3.7",
-        "eslint": "8.38.0",
+        "eslint": "8.42.0",
         "eslint-config-prettier": "8.8.0",
-        "eslint-plugin-jsdoc": "41.1.1",
+        "eslint-plugin-jsdoc": "46.2.0",
         "eslint-plugin-mocha": "10.1.0",
         "eslint-plugin-prettier": "4.2.1",
-        "eslint-plugin-unicorn": "46.0.0",
+        "eslint-plugin-unicorn": "47.0.0",
         "husky": "8.0.3",
         "mocha": "10.2.0",
         "nyc": "15.1.0",
         "prettier-eslint": "15.0.1",
-        "sinon": "15.0.3"
+        "sinon": "15.1.0"
     },
     "engines": {
-        "npm": ">=6.14.4",
-        "node": ">=14.0.0"
-    }
+        "npm": ">=9.5.1",
+        "node": ">=18.16.0"
+    },
+    "type": "module"
 }

package/test/auth.test.js

@@ -1,8 +1,8 @@
-const assert = require('chai').assert;
-const SDK = require('../lib');
-const { defaultSdk, mock } = require('./utils.js');
-const resources = require('./resources/auth.json');
-const { isConnectionError } = require('../lib/util');
+import { assert } from 'chai';
+import SDK from '../lib/index.js';
+import { defaultSdk, mock } from './utils.js';
+import { success, unauthorized } from './resources/auth.js';
+import { isConnectionError } from '../lib/util.js';
 
 describe('auth', function () {
     afterEach(function () {
@@ -10,7 +10,6 @@ describe('auth', function () {
     });
     it('should return an auth payload with token', async function () {
         //given
-        const { success } = resources;
 
         //when
         mock.onPost(success.url).reply(success.status, success.response);
@@ -22,7 +21,7 @@ describe('auth', function () {
     });
     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);
         // when
         const sdk = defaultSdk();
@@ -35,7 +34,6 @@ describe('auth', function () {
     });
     it('should return an unauthorized error', async function () {
         //given
-        const { unauthorized } = resources;
         mock.onPost(unauthorized.url).reply(unauthorized.status, unauthorized.response);
         // when
         const auth = defaultSdk().auth.getAccessToken();
@@ -156,7 +154,6 @@ describe('auth', function () {
 
     it('RETRY: should return an success, after a connection issues', async function () {
         //given
-        const { success } = resources;
 
         //when
         mock.onPost(success.url)
@@ -171,7 +168,6 @@ describe('auth', function () {
     });
     it('FAILED RETRY: should return an error, after multiple connection issues', async function () {
         //given
-        const { success } = resources;
 
         //when
         mock.onPost(success.url).timeout();

package/test/resources/auth.js

@@ -0,0 +1,32 @@
+export const success = {
+    url: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.auth.marketingcloudapis.com/v2/token',
+    response: {
+        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',
+        soap_instance_url: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.soap.marketingcloudapis.com/',
+        rest_instance_url: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.rest.marketingcloudapis.com/',
+    },
+    status: 200,
+};
+export const unauthorized = {
+    url: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.auth.marketingcloudapis.com/v2/token',
+    response: {
+        error: 'invalid_client',
+        error_description:
+            'Client authentication failed. Make sure that the client ID and client secret are valid and that the package is installed and enabled.',
+        error_uri: 'https://developer.salesforce.com/docs',
+    },
+    status: 401,
+};
+export const expired = {
+    url: 'https://mct0l7nxfq2r988t1kxfy8sc47ma.auth.marketingcloudapis.com/v2/token',
+    response: {
+        documentation:
+            'https://developer.salesforce.com/docs/atlas.en-us.mc-apis.meta/mc-apis/error-handling.htm',
+        errorcode: 0,
+        message: 'Not Authorized',
+    },
+    status: 401,
+};