chore: merge develop to master

.github/workflows/node.js.yml

@@ -16,43 +16,36 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 22.x]
+        node-version: [20.x, 22.x, 24.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@v7
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
     - run: npm ci
     - run: npm test
+    # Run CommonJS compatibility test
+    - run: npm run test:cjs
     # Run static analysis on JS files
     - run: npm run eslint
     # Run static analysis on TS files
     - run: npm run tseslint
 
-  # Checks code formatting, fails if there are changes after applying prettier.
-  # Based on this example here:
-  # https://github.com/creyD/prettier_action?tab=readme-ov-file#example-4-dry-run
+  # Checks code formatting using the version pinned in package-lock.json.
   prettier:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
+      - name: Use Node.js 24.x
+        uses: actions/setup-node@v7
         with:
-          # Make sure the actual branch is checked out when running on pull requests
-          ref: ${{ github.head_ref }}
-          # Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
-          persist-credentials: false
-
-      - name: Prettify code
-        uses: creyD/prettier_action@v4.3
-        with:
-          # "dry" causes that if any file is modified, the job fails
-          dry: True
-          # "write" performs changes in place
-          prettier_options: --write lib/*.ts test/*.js examples/**/*.js
-          github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
+          node-version: 24.x
+          cache: 'npm'
+      - run: npm ci
+      - run: npm exec -- prettier --check "lib/*.ts" "test/*.js" "examples/**/*.js"

.github/workflows/pr.yml

@@ -12,12 +12,12 @@ jobs:
     name: Validate PR title
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v5
+      - uses: amannn/action-semantic-pull-request@v6
         id: lint_pr_title
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: marocchino/sticky-pull-request-comment@v2
+      - uses: marocchino/sticky-pull-request-comment@v3
         # When the previous steps fails, the workflow would stop. By adding this
         # condition you can continue the execution with the populated error message.
         if: always() && (steps.lint_pr_title.outputs.error_message != null)
@@ -31,7 +31,7 @@ jobs:
             ```
       # Delete a previous comment when the issue has been resolved
       - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
-        uses: marocchino/sticky-pull-request-comment@v2
+        uses: marocchino/sticky-pull-request-comment@v3
         with:
           header: pr-title-lint-error
           delete: true

AGENTS.md

@@ -0,0 +1,111 @@
+# AGENTS.md
+
+## Project Overview
+
+**raygun4node** is the official Raygun.com Node.js SDK, written in TypeScript. It enables Node.js applications to send crash reports and error data to the Raygun error monitoring service.
+
+### Key Features
+
+- Error reporting to Raygun API
+- Express.js middleware integration
+- Breadcrumbs for debugging context
+- Batched error transport for high-volume apps
+- Offline caching with disk or custom storage providers
+- Source map support for stack traces
+- Custom error grouping and tagging
+- User tracking for affected customer counts
+
+## Repository Structure
+
+```
+lib/           # TypeScript source files
+  raygun.ts              # Main Client class
+  raygun.transport.ts    # HTTP transport for sending errors
+  raygun.batch.ts        # Batched transport mode
+  raygun.offline.ts      # Offline caching provider
+  raygun.breadcrumbs.ts  # Breadcrumb tracking
+  raygun.messageBuilder.ts # Error payload builder
+  types.ts               # TypeScript type definitions
+build/         # Compiled JavaScript output
+test/          # Test files (tap test framework)
+examples/      # Usage examples
+```
+
+## Commands
+
+### Build
+
+```bash
+npm run prepare    # Compiles TypeScript to build/
+```
+
+### Test
+
+```bash
+npm test           # Runs tests using tap with ts-node
+```
+
+### Lint
+
+```bash
+npm run eslint     # Lint JS files (test/*.js, examples/)
+npm run tseslint   # Lint TS files (lib/*.ts)
+npm run prettier   # Format all source files
+```
+
+## Tech Stack
+
+- **Language**: TypeScript (compiled to ES5 CommonJS)
+- **Runtime**: Node.js (>= 0.10.0)
+- **Test Framework**: tap
+- **Linting**: ESLint + TypeScript ESLint
+- **Formatting**: Prettier
+
+## Key Dependencies
+
+- `stack-trace`: Stack trace parsing
+- `debug`: Debug logging (enabled via `DEBUG=raygun`)
+
+## Examples
+
+Two example applications are provided in `examples/`:
+
+### Express Sample (`examples/express-sample/`)
+
+Demonstrates Express.js integration with Raygun middleware and breadcrumbs.
+
+```bash
+# From project root, build the package first
+npm install
+
+# Configure API key in examples/express-sample/config/default.json
+# Then run the example
+cd examples/express-sample
+npm install && npm start
+```
+
+Key files:
+- `raygun.client.js` - Raygun client setup
+- `app.js` - Express middleware configuration
+- `routes/index.js` - `/send` and `/error` endpoints
+
+### Using Domains (`examples/using-domains/`)
+
+Shows how to use Raygun with Node.js domains (legacy, prefer `reportUncaughtExceptions` for Node 12+).
+
+```bash
+# From project root, build the package first
+npm install
+
+# Configure API key in examples/using-domains/config/default.json
+# Then run the example
+cd examples/using-domains
+npm install && node app
+```
+
+## Code Conventions
+
+- Source files are in `lib/` as `.ts` files
+- Tests are in `test/` as `.js` files
+- Entry point: `build/raygun.js` with types at `build/raygun.d.ts`
+- Use strict TypeScript (`"strict": true`)