sfmc-sdk 2.1.2 → 2.1.3

package/.fork/custom-commands.json

@@ -1,26 +1,134 @@
 [
   {
-    "name": "Create PR to develop branch",
-    "target": "ref",
+    "version": 1
+  },
+  {
+    "action": {
+      "type": "url",
+      "url": "https://github.com/DougMidgley/SFMC-SDK/compare/main...${ref:short}?expand=1&template=pr_template_release.md"
+    },
+    "name": "Create PR/Release-PR to master branch",
     "refTargets": [
       "localbranch",
       "remotebranch"
     ],
+    "target": "ref"
+  },
+  {
     "action": {
       "type": "url",
-      "url": "https://github.com/DougMidgley/SFMC-SDK/compare/develop...$shortname?expand=1"
-    }
+      "url": "https://github.com/DougMidgley/SFMC-SDK/compare/develop...${ref:short}?expand=1"
+    },
+    "name": "Create PR/To develop branch",
+    "refTargets": [
+      "localbranch",
+      "remotebranch"
+    ],
+    "target": "ref"
   },
   {
-    "name": "Create PR to hotfix branch",
-    "target": "ref",
+    "action": {
+      "type": "url",
+      "url": "https://github.com/DougMidgley/SFMC-SDK/compare/hotfix...${ref:short}?expand=1"
+    },
+    "name": "Create PR/To hotfix branch",
     "refTargets": [
       "localbranch",
       "remotebranch"
     ],
+    "target": "ref"
+  },
+  {
     "action": {
-      "type": "url",
-      "url": "https://github.com/DougMidgley/SFMC-SDK/compare/hotfix...$shortname?expand=1"
+      "script": "SKIP_HOOKS=1 git switch ${ref}",
+      "showOutput": false,
+      "type": "sh",
+      "waitForExit": true
+    },
+    "name": "Skip Hooks/Checkout",
+    "refTargets": ["localbranch"],
+    "target": "ref"
+  },
+  {
+    "action": {
+      "script": "SKIP_HOOKS=1 git switch ${ref:short} && SKIP_HOOKS=2 git pull",
+      "showOutput": false,
+      "type": "sh",
+      "waitForExit": true
+    },
+    "name": "Skip Hooks/Checkout & Pull",
+    "refTargets": ["remotebranch"],
+    "target": "ref"
+  },
+  {
+    "name": "Skip Hooks/Commit",
+    "refTargets": [
+      "localbranch",
+      "remotebranch"
+    ],
+    "target": "ref",
+    "ui": {
+      "buttons": [
+        {
+          "action": {
+            "args": "commit -n -m \"$1{text}\" -m \" $2{text}\"",
+            "path": "${git}",
+            "showOutput": false,
+            "type": "process",
+            "waitForExit": true
+          },
+          "title": "Commit without Hooks"
+        },
+        {
+          "action": {
+            "type": "cancel"
+          },
+          "title": "Cancel"
+        }
+      ],
+      "controls": [
+        {
+          "placeholder": "",
+          "text": "",
+          "textBoxType": "generic",
+          "title": "Commit subject",
+          "type": "textBox"
+        },
+        {
+          "placeholder": "",
+          "text": "",
+          "textBoxType": "generic",
+          "title": "Description",
+          "type": "textBox"
+        }
+      ],
+      "description": "This will create a commit but not run pre-commit hooks",
+      "title": "Commit skipping Hooks"
     }
+  },
+  {
+    "action": {
+      "script": "SKIP_HOOKS=4 git merge ${ref:short}",
+      "showOutput": false,
+      "type": "sh",
+      "waitForExit": true
+    },
+    "name": "Skip Hooks/Merge into current branch",
+    "refTargets": ["localbranch"],
+    "target": "ref"
+  },
+  {
+    "action": {
+      "script": "SKIP_HOOKS=3 git pull",
+      "showOutput": false,
+      "type": "sh",
+      "waitForExit": true
+    },
+    "name": "Skip Hooks/Pull",
+    "refTargets": [
+      "localbranch",
+      "remotebranch"
+    ],
+    "target": "ref"
   }
 ]

package/.github/workflows/close_issues_on_merge.yml

@@ -0,0 +1,19 @@
+name: Close issues related to a merged pull request based on master branch.
+
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - develop
+      - hotfix
+
+jobs:
+  closeIssueOnPrMergeTrigger:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Closes issues related to a merged pull request.
+        uses: ldez/gha-mjolnir@v1.5.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,36 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Publish NPM on Release
+
+on:
+    release:
+        types: [published]
+
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v6
+            - uses: actions/setup-node@v6
+              with:
+                  node-version-file: ./package.json
+
+            - run: npm ci
+            - run: npm test
+
+    publish-npm:
+        needs: build
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v6
+            - uses: actions/setup-node@v6
+              with:
+                  node-version-file: ./package.json
+                  registry-url: https://registry.npmjs.org/
+            - run: npm publish
+

package/.github/workflows/prvalidation.yml

@@ -17,7 +17,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                node: [18, 20, 22]
+                node: [20, 22, 24]
         name: Run Tests with node ${{ matrix.node }}
         steps:
             - uses: actions/checkout@v4

package/.husky/post-checkout

@@ -6,11 +6,16 @@ then
   TICKETID="0"
 fi
 TEMPLATE="#$TICKETID: "
-echo "[POST_CHECKOUT] Setting template commit to '$TEMPLATE'"
+echo "[POST-CHECKOUT] Setting template commit to '$TEMPLATE'"
 # wrap $TEMPLATE in quotes or else it is trimmed automatically
 echo "$TEMPLATE" > ".git/templatemessage"
 
 
+if [[ $SKIP_HOOKS>0 ]]; then
+  echo "[POST-CHECKOUT] skipping hooks ($SKIP_HOOKS)"
+  exit 0
+fi
+
 # ### run npm install ###
 echo "[POST-CHECKOUT] 📦 Checking for changes to dependencies"
 # define how to split strings into array elements
@@ -21,7 +26,7 @@ NEWHEAD=$1
 OLDHEAD=$2
 # extract all paths to package-lock.json files
 PACKAGE_LOCK_REGEX="(^package-lock\.json)"
-PACKAGES=$(git diff --name-only $NEWHEAD $OLDHEAD | grep -E $PACKAGE_LOCK_REGEX || true)
+PACKAGES=$(git diff --name-only $OLDHEAD $NEWHEAD | grep -E $PACKAGE_LOCK_REGEX || true)
 
 if [[ ${PACKAGES[@]} ]]; then
   for package in $PACKAGES; do

package/.husky/post-merge

@@ -0,0 +1,24 @@
+if [[ $SKIP_HOOKS>0 ]]; then
+  echo "[POST-MERGE] skipping hooks ($SKIP_HOOKS)"
+  exit 0
+fi
+
+# ### run npm install ###
+echo "[POST-MERGE] 📦 Checking for changes to dependencies"
+# define how to split strings into array elements
+IFS=$'\n'
+# extract all paths to package-lock.json files
+PACKAGE_LOCK_REGEX="(^package-lock\.json)"
+echo "[POST-MERGE] running git diff --name-only HEAD^1 HEAD"
+PACKAGES=$(git diff --name-only HEAD^1 HEAD | grep -E $PACKAGE_LOCK_REGEX || true)
+
+if [[ ${PACKAGES[@]} ]]; then
+  for package in $PACKAGES; do
+    echo "📦 $package was changed."
+  done
+  echo "📦 Running npm install to update your dependencies..."
+  npm install
+  npm run lint:fix
+else
+  echo "📦 All packages up-to-date. No need to run npm install."
+fi

package/.husky/pre-commit

@@ -1,3 +1,4 @@
 # update typescript type declarations
-npx tsc -p tsconfig.precommit.json
+echo "[PRE-COMMIT] Run typescript validation and create/update d.ts files"
+tsc -p tsconfig.precommit.json
 git add @types

package/@types/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../lib/util.js"],"names":[],"mappings":"AACA;;;;;GAKG;AACH,iCAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;GAKG;AACH,kCAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;GAKG;AACH,wCAHW,MAAM,GACJ,OAAO,CAOnB;AAED;;;;;;GAMG;AACH;;;;;GAKG;AACH;IACI;;;OAGG;IACH,gBAFW,iBAAiB,EAwB3B;IAlBO,UAAiD;IAWjD,iBAA2B;IAE/B,cAA2B;CAMlC;AACD;;;;;;GAMG;AACH;;;;;GAKG;AACH;IACI;;;;;OAKG;IACH,gBAJW,iBAAiB,YACjB,MAAM,YACN,MAAM,EAwChB;IAlCO,UAAkC;IA4BtC,cAAwB;IACxB,UAAoB;CAM3B;AAED,0DAA4C;;;;;;;;cArG9B,MAAM;;;;UACN,MAAM;;;;cACN,MAAM;;;;;gCACP,KAAK,GAAG,uBAAuB;;;;;;;;cAuC9B,MAAM;;;;UACN,MAAM;;;;cACN,MAAM;;;;;gCACP,KAAK,GAAG,uBAAuB"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../lib/util.js"],"names":[],"mappings":"AACA;;;;;GAKG;AACH,iCAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;GAKG;AACH,kCAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;GAKG;AACH,wCAHW,MAAM,GACJ,OAAO,CAOnB;AAED;;;;;;GAMG;AACH;;;;;GAKG;AACH;IACI;;;OAGG;IACH,gBAFW,iBAAiB,EAqB3B;IAfO,UAAiD;IAWjD,iBAA2B;IAE/B,cAA2B;CAGlC;AACD;;;;;;GAMG;AACH;;;;;GAKG;AACH;IACI;;;;;OAKG;IACH,gBAJW,iBAAiB,YACjB,MAAM,YACN,MAAM,EAqChB;IA/BO,UAAkC;IA4BtC,cAAwB;IACxB,UAAoB;CAG3B;AAED,0DAA4C;;;;;;;;cA/F9B,MAAM;;;;UACN,MAAM;;;;cACN,MAAM;;;;;gCACP,KAAK,GAAG,uBAAuB;;;;;;;;cAoC9B,MAAM;;;;UACN,MAAM;;;;cACN,MAAM;;;;;gCACP,KAAK,GAAG,uBAAuB"}

package/eslint.config.js

@@ -28,6 +28,12 @@ export default [
         ignores: ['/node_modules/**'],
         rules: {
             'unicorn/prefer-module': 'off',
+            'unicorn/prevent-abbreviations': [
+                'error',
+                {
+                    checkFilenames: false,
+                },
+            ],
             'unicorn/numeric-separators-style': 'off',
             'jsdoc/check-line-alignment': 2,
             'jsdoc/require-jsdoc': [

package/lib/rest.js

@@ -125,13 +125,13 @@ export default class Rest {
             }
             // ! 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 (
-                isTransactionalMessageApi &&
-                responseBatch[countKey] != responseBatch[pageSizeKey]
-            ) {
-                shouldPaginate = false;
-            }
-            // if results are less than size, no more requested needed
+            if (isTransactionalMessageApi && responseBatch[countKey] == pageSize) {
+                page++;
+                shouldPaginate = true;
+                if (this.options?.eventHandlers?.onLoop) {
+                    this.options.eventHandlers.onLoop(undefined, collector?.[iteratorField]);
+                }
+            } // if results are less than size, no more requested needed
             else if (responseBatch[iteratorField].length < pageSize) {
                 shouldPaginate = false;
             }

package/lib/util.js

@@ -69,9 +69,6 @@ export class RestError extends Error {
         }
         this.response = ex.response;
         this.name = this.constructor.name;
-        if (Error.captureStackTrace) {
-            Error.captureStackTrace(this, RestError);
-        }
     }
 }
 /**
@@ -129,9 +126,6 @@ export class SOAPError extends Error {
         this.response = response;
         this.json = soapBody;
         this.name = this.constructor.name;
-        if (Error.captureStackTrace) {
-            Error.captureStackTrace(this, SOAPError);
-        }
     }
 }
 import axios from 'axios';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sfmc-sdk",
-    "version": "2.1.2",
+    "version": "2.1.3",
     "description": "Libarary to simplify SFMC requests with updated dependencies and less overhead",
     "main": "./lib/index.js",
     "exports": {
@@ -18,7 +18,14 @@
         "lint": "eslint ./lib ./test",
         "lint:fix": "eslint ./lib ./test --fix",
         "lint-ts": "tsc -p tsconfig.precommit.json",
-        "prepare": "husky || true"
+        "lint-ts-prep": "tsc -p tsconfig.npmScripts.json",
+        "prepare": "husky || true",
+        "prepare-release:audit-fix": "npm audit fix",
+        "prepare-release:git": "node prepare-release.js",
+        "prepare-release": "run-s prepare-release:audit-fix lint-ts-prep lint:fix prepare-release:git",
+        "version:major": "npm version --no-commit-hooks major",
+        "version:minor": "npm version --no-commit-hooks minor",
+        "version:patch": "npm version --no-commit-hooks patch"
     },
     "repository": {
         "type": "git",
@@ -28,7 +35,7 @@
     "license": "BSD-3-Clause",
     "dependencies": {
         "axios": "^1.7.2",
-        "fast-xml-parser": "4.4.1",
+        "fast-xml-parser": "5.3.4",
         "p-limit": "5.0.0"
     },
     "keywords": [
@@ -43,25 +50,26 @@
         "sdk"
     ],
     "devDependencies": {
-        "@eslint/js": "9.6.0",
+        "@eslint/js": "9.39.2",
         "@types/mocha": "10.0.7",
-        "@types/node": "20.14.9",
+        "@types/node": "25.2.1",
         "assert": "2.1.0",
         "axios-mock-adapter": "1.22.0",
         "c8": "10.1.2",
         "chai": "5.1.1",
-        "eslint": "9.6.0",
+        "eslint": "9.39.2",
         "eslint-config-prettier": "9.1.0",
-        "eslint-plugin-jsdoc": "48.5.0",
+        "eslint-plugin-jsdoc": "62.5.2",
         "eslint-plugin-mocha": "10.4.3",
         "eslint-plugin-prettier": "5.1.3",
-        "eslint-plugin-unicorn": "54.0.0",
-        "husky": "9.0.11",
-        "mocha": "10.5.2",
+        "eslint-plugin-unicorn": "62.0.0",
+        "husky": "9.1.7",
+        "mocha": "11.7.5",
+        "npm-run-all": "4.1.5",
         "prettier": "3.3.2",
         "prettier-eslint": "16.3.0",
         "sinon": "18.0.0",
-        "typescript": "5.5.2"
+        "typescript": "5.9.3"
     },
     "engines": {
         "npm": ">=9",

package/prepare-release.js

@@ -0,0 +1,37 @@
+/* eslint-disable no-console */
+import { exec } from 'node:child_process';
+
+console.log('> git status --porcelain');
+exec('git status --porcelain', (err, stdout, stderr) => {
+    if (err) {
+        console.error(`Error executing git status: ${stderr}`);
+        return;
+    }
+
+    if (stdout) {
+        console.log(
+            '    Found changes:',
+            '\n     - ' + stdout.split('\n').filter(Boolean).join('\n     - ')
+        );
+        console.log('> git add .');
+        exec('git add .', (err, stdout, stderr) => {
+            if (err) {
+                console.error(`Error executing git add: ${stderr}`);
+                return;
+            }
+
+            console.log('> git commit -n -m "prepare-release changes"');
+            exec('git commit -n -m "prepare-release changes"', (err, stdout, stderr) => {
+                if (err) {
+                    console.error(`Error executing git commit: ${stderr}`);
+                    return;
+                } else {
+                    console.log('✅ Changes committed successfully.');
+                }
+            });
+        });
+    } else {
+        console.log('✅ No untracked files to commit.');
+    }
+});
+/* eslint-enable no-console */

package/.github/workflows/release.yml

@@ -1,39 +0,0 @@
-name: Release Package
-
-on:
-    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@v6
-              id: create_release
-              env:
-                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-            - uses: actions/checkout@v4
-            - uses: actions/setup-node@v4
-              with:
-                  node-version: 22
-                  registry-url: https://registry.npmjs.org/
-            - 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 }}