Merge branch 'main' into patch-1

.github/DISCUSSION_TEMPLATE/help.yml

@@ -8,6 +8,6 @@ body:
   - type: input
     attributes:
       label: Example
-      description: A link to a minimal reproduction is helpful for debugging! You can fork [this stackblitz setup](https://stackblitz.com/edit/sqs-consumer-starter) to get a reproduction setup quickly.
+      description: A link to a minimal reproduction is helpful for debugging! You can use one of our [existing examples](https://github.com/bbc/sqs-consumer-starter/tree/main/examples) to get a reproduction setup quickly.
     validations:
       required: false

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -32,7 +32,7 @@ body:
         Please add a link to a minimal reproduction.
         Note:
         - Please keep your example as simple and reproduceable as possible, try leaving out dependencies that are not required for reproduction.
-        - To create a shareable code example for web, you can use Stackblitz (https://stackblitz.com/edit/sqs-consumer-starter).
+        - To create a shareable code example for web, you can use one of our existing examples: (https://github.com/bbc/sqs-consumer-starter/tree/main/examples).
         - Please make sure the example is complete and runnable - e.g. avoid localhost URLs.
       placeholder: |
         e.g. Code Sandbox, Stackblitz, Expo Snack or TypeScript playground

.github/workflows/annotate-test-reports.yml

@@ -0,0 +1,32 @@
+name: Annotate CI run with test results
+on:
+  workflow_run:
+    workflows:
+      - "Run Tests"
+    types:
+      - completed
+permissions:
+  actions: read
+  contents: read
+  checks: write
+  pull-requests: write
+
+jobs:
+  annotate:
+    name: Annotate CI run with test results
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion != 'cancelled' }}
+    strategy:
+       fail-fast: false
+       matrix:
+        node-version: [18.x, 20.x, 22.x]
+    timeout-minutes: 5
+    steps:
+      - name: Annotate CI run with test results
+        uses: dorny/test-reporter@v1
+        with:
+          artifact: test-reports-${{ matrix.node-version }}
+          name: Test Results (${{matrix.node-version}}
+          path: "test-results.json"
+          reporter: mocha-json
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/coverage.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [20.x]
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/docs.yml

@@ -34,7 +34,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: 20.x
           cache: 'npm'
 
       - name: NPM Audit

.github/workflows/pr-coverage.yml

@@ -0,0 +1,42 @@
+name: Comment PR Coverage
+on:
+  pull_request:
+    branches:
+      - 'main'
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  coverage_report:
+    name: Generate coverage report
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20.x]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install Node Modules
+        run: npm ci
+
+      - name: Run Coverage Check
+        run: npm run lcov
+
+      - name: Setup LCOV
+        uses: hrishikesh-kadam/setup-lcov@v1
+
+      - name: Report code coverage
+        uses: zgosalvez/github-actions-report-lcov@v3
+        with:
+          coverage-files: coverage/lcov.info
+          minimum-coverage: 90
+          artifact-name: code-coverage-report
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          update-comment: true

.github/workflows/test.yml

@@ -8,13 +8,15 @@ on:
       - main
 permissions:
   contents: read
+  checks: write
+  pull-requests: write
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18.x, 20.x]
+        node-version: [18.x, 20.x, 22.x]
 
     steps:
       - uses: actions/checkout@v4
@@ -34,7 +36,7 @@ jobs:
       - name: Run Tests and Linting
         run: npm run test
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: test-reports-${{ matrix.node-version }}
           path: test/reports/

package.json

@@ -1,14 +1,20 @@
 {
   "name": "sqs-consumer",
-  "version": "10.0.0-canary.2",
+  "version": "10.1.0",
   "description": "Build SQS-based Node applications without the boilerplate",
   "type": "module",
+  "main": "dist/cjs/index.js",
+  "types": "dist/cjs/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
-      "require": "./dist/cjs/index.js",
-      "import": "./dist/esm/index.js",
-      "default": "./dist/esm/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     }
   },
   "engines": {
@@ -21,7 +27,7 @@
     "build": "npm run clean && npm run compile && npm run add-package-jsons",
     "watch": "tsc --watch",
     "prepublishOnly": "npm run build",
-    "test:unit": "mocha --recursive --full-trace --exit",
+    "test:unit": "mocha --recursive --full-trace --exit --reporter json > test/reports/test-results.json",
     "pretest:integration:init": "npm run build",
     "test:integration:init": "sh ./test/scripts/initIntTests.sh",
     "test:integration": "npm run test:integration:init && cucumber-js --config ./test/config/cucumber.mjs",

scripts/addPackageJsons.js

@@ -8,6 +8,10 @@ function buildPackageJson() {
       throw err;
     }
     dirs.forEach((dir) => {
+      if (dir === "types") {
+        return;
+      }
+
       const packageJsonFile = join(buildDir, dir, "/package.json");
 
       if (!existsSync(packageJsonFile)) {