sfmc-sdk 0.2.1 → 0.5.0

package/.eslintrc.json

@@ -10,10 +10,7 @@
         "plugin:jsdoc/recommended",
         "plugin:prettier/recommended"
     ],
-    "plugins": [
-        "mocha",
-        "jsdoc"
-    ],
+    "plugins": ["mocha", "jsdoc"],
     "globals": {
         "Atomics": "readonly",
         "SharedArrayBuffer": "readonly"
@@ -22,4 +19,4 @@
         "ecmaVersion": 2020,
         "sourceType": "module"
     }
-}
+}

package/.github/dependabot.yml

@@ -5,9 +5,12 @@
 
 version: 2
 updates:
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "daily"
-    ignore:
-    - dependency-name: "p-limit" #v4 only supports ESM so keeping on v3
+    - package-ecosystem: 'npm' # See documentation for possible values
+      directory: '/' # Location of package manifests
+      schedule:
+          interval: 'daily'
+      ignore:
+          - dependency-name: 'p-limit' #v4 only supports ESM so keeping on v3
+      target-branch: 'develop'
+      labels:
+          - 'chore'

package/.github/pr-labeler.yml

@@ -1,4 +1,4 @@
 enhancement: feature/*
 bug: bug/*
 chore: chore/*
-release: develop
+release: develop

package/.github/release-drafter.yml

@@ -1,31 +1,31 @@
 name-template: '$RESOLVED_VERSION'
 tag-template: '$RESOLVED_VERSION'
 exclude-labels:
-  - 'release'
+    - 'release'
 categories:
-  - title: '🚀 Features'
-    labels:
-      - 'enhancement'
-  - title: '🐛 Bug Fixes'
-    labels:
-      - 'bug'
-  - title: '🧰 Maintenance'
-    label: 'chore'
+    - title: '🚀 Features'
+      labels:
+          - 'enhancement'
+    - title: '🐛 Bug Fixes'
+      labels:
+          - 'bug'
+    - title: '🧰 Maintenance'
+      label: 'chore'
 version-resolver:
-  major:
-    labels:
-      - 'major'
-  minor:
-    labels:
-      - 'minor'
-      - 'enhancement'
-  patch:
-    labels:
-      - 'patch'
-      - 'bug'
-      - 'chore'
-  default: patch
+    major:
+        labels:
+            - 'major'
+    minor:
+        labels:
+            - 'minor'
+            - 'enhancement'
+    patch:
+        labels:
+            - 'patch'
+            - 'bug'
+            - 'chore'
+    default: patch
 template: |
-  ## Release Notes
+    ## Release Notes
 
-  $CHANGES
+    $CHANGES

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

@@ -9,37 +9,37 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
-  push:
-    branches: [ main, develop ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ main, develop ]
+    push:
+        branches: [main, develop]
+    pull_request:
+        # The branches below must be a subset of the branches above
+        branches: [main, develop]
 
 jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
+    analyze:
+        name: Analyze
+        runs-on: ubuntu-latest
 
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
-        # Learn more:
-        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+        strategy:
+            fail-fast: false
+            matrix:
+                language: ['javascript']
+                # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+                # Learn more:
+                # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v2
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
+            # Initializes the CodeQL tools for scanning.
+            - name: Initialize CodeQL
+              uses: github/codeql-action/init@v1
+              with:
+                  languages: ${{ matrix.language }}
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+            - name: Perform CodeQL Analysis
+              uses: github/codeql-action/analyze@v1

package/.github/workflows/prvalidation.yml

@@ -1,26 +1,26 @@
 name: PR Validation
 on:
-  pull_request:
-    types: [opened, reopened, synchronize]
+    pull_request:
+        types: [opened, reopened, synchronize]
 
 jobs:
-  pr-labeler:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: TimonVS/pr-labeler-action@v3
-        with:
-          configuration-path: .github/pr-labeler.yml # optional, .github/pr-labeler.yml is the default value
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  test:
-    runs-on: ubuntu-latest
-    
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm install
-      - run: npm run lint
-      - run: npm run test
+    pr-labeler:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: TimonVS/pr-labeler-action@v3
+              with:
+                  configuration-path: .github/pr-labeler.yml # optional, .github/pr-labeler.yml is the default value
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    test:
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v2
+              with:
+                  node-version: 16
+                  registry-url: https://registry.npmjs.org/
+            - run: npm install
+            - run: npm run lint
+            - run: npm run test

package/.github/workflows/release.yml

@@ -1,42 +1,42 @@
 name: Release Package
 
 on:
-  push:
-    # branches to consider in the event; optional, defaults to all
-    branches:
-      - main
+    push:
+        # branches to consider in the event; optional, defaults to all
+        branches:
+            - main
 
 jobs:
-  update_release_draft:
-    runs-on: ubuntu-latest
-    steps:
-      # Drafts your next Release notes as Pull Requests are merged into "main"
-      - uses: release-drafter/release-drafter@v5
-        id: create_release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - uses: HarmvZ/set-package-json-version-action@v0.1.2
-        with:
-          version: ${{ steps.create_release.outputs.tag_name }}
-      - run: npm i
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}
-      - run: |
-          git config user.name "GitHub Actions Bot"
-          git config user.email "<>"
-          git add package.json
-          git add package-lock.json
-          git commit -m "Release ${{ steps.create_release.outputs.tag_name }}"
-          git push origin main
-      - uses: eregon/publish-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          release_id: ${{ steps.create_release.outputs.id }}
+    update_release_draft:
+        runs-on: ubuntu-latest
+        steps:
+            # Drafts your next Release notes as Pull Requests are merged into "main"
+            - uses: release-drafter/release-drafter@v5
+              id: create_release
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v2
+              with:
+                  node-version: 16
+                  registry-url: https://registry.npmjs.org/
+            - uses: HarmvZ/set-package-json-version-action@v0.1.2
+              with:
+                  version: ${{ steps.create_release.outputs.tag_name }}
+            - run: npm i
+            - run: npm ci
+            - run: npm publish
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}
+            - run: |
+                  git config user.name "GitHub Actions Bot"
+                  git config user.email "<>"
+                  git add package.json
+                  git add package-lock.json
+                  git commit -m "Release ${{ steps.create_release.outputs.tag_name }}"
+                  git push origin main
+            - uses: eregon/publish-release@v1
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              with:
+                  release_id: ${{ steps.create_release.outputs.id }}

package/.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-    "editor.formatOnSave": true
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
 }

package/PULL_REQUEST_TEMPLATE.md

@@ -2,11 +2,11 @@
 
 ## What is the purpose of this pull request? (put an "X" next to an item)
 
-- [ ] Fix
-- [ ] Improvements
-- [ ] New Feature
-- [ ] Documentation updates
-- [ ] Other, please explain:
+-   [ ] Fix
+-   [ ] Improvements
+-   [ ] New Feature
+-   [ ] Documentation updates
+-   [ ] Other, please explain:
 
 ## What changes did you make? (Give an overview)
 

package/README.md

@@ -21,11 +21,11 @@ This library attempts to overcomes some of the complexity/shortcomings of the or
 
 ## Usage
 
-### Initialization
+### Authorization
 
 Initializes the Auth Object in the SDK.
 The SDK will automatically request a new token if none is valid.
-the second parameter in the constructor is to allow for specific events to execute a function. Currently onRefresh and onLoop are supported. This reduces the number of requests for token therefore increasing speed between executions (when testing was 2.5 seconds down to 1.5 seconds for one rest and one soap request)
+the second parameter in the constructor is to allow for specific options such as events to execute a function. See the below example for supported events. This reduces the number of requests for token therefore increasing speed between executions (when testing was 2.5 seconds down to 1.5 seconds for one rest and one soap request)
 
 ```javascript
 const SDK = require('sfmc-sdk');
@@ -37,17 +37,36 @@ const sfmc = new SDK(
         account_id: 7281698,
     },
     {
-        onLoop: (type, accumulator) => console.log("Looping", type, accumlator.length),
-        onRefresh: (options) => console.log("RefreshingToken.", Options),
-        logRequest: (req) => console.log(req),
-        logResponse: (res) => console.log(res)
+        eventHandlers: {
+            onLoop: (type, accumulator) => console.log('Looping', type, accumlator.length),
+            onRefresh: (options) => console.log('RefreshingToken.', Options),
+            logRequest: (req) => console.log(req),
+            logResponse: (res) => console.log(res),
+            onConnectionError: (ex, remainingAttempts) => console.log(ex.code, remainingAttempts)
+
+        },
+        requestAttempts : 1
+        retryOnConnectionError: true
     }
 );
 ```
 
+Additionally, a list of supported scopes can be retrieved by using the auth.getSupportedScopes method.
+
+```javascript
+const scopes = sfmc.auth.getSupportedScopes();
+```
+
 ### SOAP
 
-SOAP currently only supports all the standard SOAP action types. Some examples below
+SOAP currently only supports all the standard SOAP action types.
+General format is
+
+-   Object Name
+-   Parameters/Object
+-   Request Options
+
+Some examples below
 
 ```javascript
 const soapRetrieve = await sfmc.soap.retrieve('DataExtension', ['ObjectID'], {});
@@ -59,25 +78,35 @@ const soapRetrieveBulk = await sfmc.soap.retrieveBulk('DataExtension', ['ObjectI
     },
 }); // 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"
-    }], {});
+    '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
@@ -90,7 +119,10 @@ const restResponse = await sfmc.rest.post('/interaction/v1/interactions', jsonPa
 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
+const restResponse = await sfmc.rest.getCollection(
+    ['/interaction/v1/interactions/213', '/interaction/v1/interactions/123'],
+    3
+); // parallel requests
 ```
 
 ## Contributing
@@ -103,7 +135,6 @@ Please make sure to update tests as appropriate.
 
 -   Look at persisting access tokens across sessions as an option
 -   Validation improvement
--   Support Scopes in API Requests
 
 ## License