sfmc-sdk 0.0.3 → 0.0.7

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## SFMC SDK follows [semantic versioning](https://semver.org/).
 
+## 0.0.7 - 2021-12-23
+- Revert P-Limit Dependency Bump
+
+## 0.0.6 - 2021-12-23
+
+- Bump dependency versions
+- Extended SOAP action support to other types
+- Added SOAP Retreive Bulk
+- Added REST Get Collection & GetBulk features
+
 ## 0.0.2 - 2021-04-10
 
 NPM Publishing

package/PULL_REQUEST_TEMPLATE.md

@@ -4,10 +4,7 @@
 
 - [ ] Documentation update
 - [ ] Bug fix
-- [ ] New metadata support
-- [ ] Enhanced metadata
-- [ ] Add a CLI option
-- [ ] Add something to the core
+- [ ] Extend features
 - [ ] Other, please explain:
 
 ## What changes did you make? (Give an overview)

package/README.md

@@ -17,6 +17,7 @@ This library attempts to overcomes some of the complexity/shortcomings of the or
 -   Only uses Promises/Async-Await, no callbacks
 -   Maintainers of the semi-official lib from Salesforce are not responsive
 -   Allows for using a persisting credentials in an external app, then passing
+-   We expect parsing of SOAP to
 
 ## Usage
 
@@ -41,10 +42,31 @@ const sfmc = new SDK(
 
 ### SOAP
 
-SOAP currently only supports retrieve, will be updating soon for other types.
+SOAP currently only supports all the standard SOAP action types. Some examples below
 
 ```javascript
-const soapResponse = await sfmc.soap.retrieve('DataExtension', ['ObjectID'], {});
+const soapRetrieve = await sfmc.soap.retrieve('DataExtension', ['ObjectID'], {});
+const soapRetrieveBulk = await sfmc.soap.retrieveBulk('DataExtension', ['ObjectID'], filter: {
+                leftOperand: 'ExternalKey',
+                operator: 'equals',
+                rightOperand: 'SOMEKEYHERE',
+            }); // when you want to auto paginate
+const soapCreate = await sfmc.soap.create('Subscriber', {
+    "SubscriberKey": "12345123",
+    "EmailAddress": "example@example.com"
+    }, {
+        "options": {
+            "SaveOptions": { "SaveAction" : "UpdateAdd" }
+        }
+    }});
+const soapUpdate = await sfmc.soap.update('Role', {
+    "CustomerKey": "12345123",
+    "Name": "UpdatedName"
+    }, {});
+const soapExecute = await sfmc.soap.execute('LogUnsubEvent', [{
+    "SubscriberKey": "12345123",
+    "EmailAddress": "example@example.com"
+    }], {});
 ```
 
 ### REST
@@ -56,6 +78,8 @@ const restResponse = await sfmc.rest.get('/interaction/v1/interactions');
 const restResponse = await sfmc.rest.post('/interaction/v1/interactions', jsonPayload);
 const restResponse = await sfmc.rest.patch('/interaction/v1/interactions/IDHERE', jsonPayload); // PUT ALSO
 const restResponse = await sfmc.rest.delete('/interaction/v1/interactions/IDHERE');
+const restResponse = await sfmc.rest.getBulk('/interaction/v1/interactions'); // auto-paginate based on $pageSize
+const restResponse = await sfmc.rest.getCollection(['/interaction/v1/interactions/213', '/interaction/v1/interactions/123'], 3); // parallel requests
 ```
 
 ## Contributing
@@ -67,7 +91,6 @@ Please make sure to update tests as appropriate.
 ## To Do
 
 -   No tests are in place
--   Improve handling for other SOAP Actions than Retrieve
 -   Look at persisting access tokens across sessions as an option
 -   Validation improvement
 -   Support Scopes in API Requests

package/lib/auth.js

@@ -39,7 +39,7 @@ module.exports = class Auth {
                 throw new Error('auth_url must be a string');
             }
             if (
-                !/https:\/\/[a-z0-9]{28}\.auth\.marketingcloudapis\.com\//gm.test(options.auth_url)
+                !/https:\/\/[a-z0-9\-]{28}\.auth\.marketingcloudapis\.com\//gm.test(options.auth_url)
             ) {
                 throw new Error(
                     'auth_url must be in format https://mcXXXXXXXXXXXXXXXXXXXXXXXXXX.auth.marketingcloudapis.com/'

package/lib/index.js

@@ -6,7 +6,7 @@ module.exports = class SDK {
     /**
      * Creates an instance of SDK.
      * @param {Object} options Auth Object for making requests
-     * @param {Object} eventHandlers collection of handler functions (for examplef or logging)
+     * @param {Object} eventHandlers collection of handler functions (for example for logging)
      */
     constructor(options, eventHandlers) {
         this.auth = new Auth(options, eventHandlers);

package/lib/soap.js

@@ -47,7 +47,7 @@ module.exports = class Soap {
                 body.RetrieveRequestMsg.RetrieveRequest.ClientIDs = requestParams.clientIDs;
             }
             // filter can be simple or complex and has three properties leftOperand, rightOperand, and operator
-            if (requestParams.Filter) {
+            if (requestParams.filter) {
                 body.RetrieveRequestMsg.RetrieveRequest.Filter = _parseFilter(requestParams.filter);
             }
             if (requestParams.QueryAllAccounts) {
@@ -358,16 +358,7 @@ function _parseFilter(filter) {
  * @return {Promise<Object|Error>} Result of request in Object format
  */
 async function _parseResponse(body, key) {
-    // const parser = new xml2js.Parser({
-    //     trim: true,
-    //     normalize: true,
-    //     explicitArray: false,
-    //     ignoreAttrs: true,
-    // });
-
-    // const payload = await parser.parseStringPromise(body);
     const payload = xmlToJson.parse(body);
-
     const soapBody = payload['soap:Envelope']['soap:Body'];
     // checks errors in Body Fault
     if (soapBody['soap:Fault']) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sfmc-sdk",
-    "version": "0.0.3",
+    "version": "0.0.7",
     "description": "Libarary to simplify SFMC requests with updated dependencies and less overhead",
     "main": "./lib/index.js",
     "scripts": {
@@ -13,8 +13,8 @@
     "author": "Doug Midgley <douglasmidgley@gmail.com>",
     "license": "BSD-3-Clause",
     "dependencies": {
-        "axios": "^0.21.1",
-        "fast-xml-parser": "3.19.0",
+        "axios": "^0.24.0",
+        "fast-xml-parser": "3.21.1",
         "p-limit": "3.1.0"
     },
     "keywords": [

package/index.js

@@ -1,17 +0,0 @@
-const SDK = require('./lib/index');
-const init = async () => {
-    console.time('init');
-    const sfmc = new SDK(
-        {
-            client_id: '71fzp43cyb1aksgflc159my0',
-            client_secret: 'oDZE354QsMXzcFqKQlGgDiH1',
-            auth_url: 'https://mct0l7nxfq2r988t1kxfy8sc47mq.auth.marketingcloudapis.com/',
-            account_id: 7281698,
-        },
-        true
-    );
-    const int = await sfmc.rest.get('/interaction/v1/interactions');
-    const de = await sfmc.soap.retrieve('DataExtension', ['ObjectID'], {});
-    console.timeEnd('init');
-};
-init();