chore: Release 0.14.0

.github/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Bug report
+title: "<Area of the SDK>: <Short Description of issue>"
+labels: needs triage
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+Links to related tickets or other context are welcome here.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. Linux/Windows/macOS etc]
+ - SDK version: [e.g. 10.5.2]
+ - Node/npm versions: [e.g. 21.7.3]
+
+** Logs**
+If applicable, include relevant logs or error messages here (please use code blocks to format properly).
+
+**Possible Solution**
+If you have suggestions for how the issue might be resolved or investigated, please describe them here.

.github/dependabot.yml

@@ -1,7 +1,46 @@
 version: 2
 updates:
+
+# raygun4node
   - package-ecosystem: "npm"
     directory: "/"
     schedule:
       interval: "weekly"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+
+# example: express
+  - package-ecosystem: "npm"
+    directory: "/examples/express-sample"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    ignore:
+      # Package in example is accessed by path, 
+      # do not update in package.json.
+      - dependency-name: "raygun4node"
+
+# example: domains
+  - package-ecosystem: "npm"
+    directory: "/examples/using-domains"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    ignore:
+      # Package in example is accessed by path, 
+      # do not update in package.json.
+      - dependency-name: "raygun4node"
 
+# Github Actions dependencies updates config
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "chore"
+      include: "scope"

.github/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: A new feature for this SDK
+title: "<Area of the SDK>: <Short Description of new feature>"
+labels: needs triage
+assignees: ''
+
+---
+
+**Please describe your new feature request**
+A clear and concise description of what the problem is. Example: I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+Links to related tickets or other information are welcome here.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/node.js.yml

@@ -0,0 +1,55 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "master", "develop" ]
+  pull_request:
+    branches: [ "master", "develop" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    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'
+    - run: npm ci
+    - run: npm test
+    - run: npm run eslint
+
+  # 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
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        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/[email protected]
+        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 }}

.github/workflows/pr.yml

@@ -0,0 +1,37 @@
+name: "Pull-Request Check"
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        id: lint_pr_title
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        # 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)
+        with:
+          header: pr-title-lint-error
+          message: |
+            We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.
+            Details:
+            ```
+            ${{ steps.lint_pr_title.outputs.error_message }}
+            ```
+      # 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
+        with:
+          header: pr-title-lint-error
+          delete: true

.gitignore

@@ -3,3 +3,4 @@
 yarn.lock
 
 build/
+.tap/

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.14.0
+- Upgrade dependencies
+- Support for Node v20
+
 ## 0.13.2
 - Fix batch transport keeping process alive
 - Fix batch transport stalling on huge errors

LICENSE-MIT

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Raygun Limited
+Copyright (c) 2024 Raygun Limited
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.md

@@ -438,7 +438,7 @@ curl
 All requests use the same authentication methods as the upload call (Basic Authentication and Token Authentication).
 
 ### Examples
-View a screencast on creating an app with Node.js and Express.js, then hooking up the error handling and sending them at [http://raygun.io/blog/2013/07/video-nodejs-error-handling-with-raygun/](http://raygun.io/blog/2013/07/video-nodejs-error-handling-with-raygun/)
+View a screencast on creating an app with Node.js and Express.js, then hooking up the error handling and sending them at [https://raygun.com/blog/2013/07/video-nodejs-error-handling-with-raygun/](https://raygun.com/blog/2013/07/video-nodejs-error-handling-with-raygun/)
 
 ### Debug Logging
 You can enable logging of debug information from the Raygun client by setting the environment variable `DEBUG=raygun`. The client will then log information about transporting and storing errors, including timing information.

eslint.config.mjs

@@ -0,0 +1,34 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+    eslint.configs.recommended,
+    ...tseslint.configs.recommended,
+    {
+        languageOptions: {
+            // Add node globals to ignore undefined
+            globals: {
+                "__dirname": false,
+                "console": false,
+                "module": false,
+                "process": false,
+                "require": false,
+                "setTimeout": false,
+            }
+        },
+        rules: {
+            // Unused vars reported as error
+            "@typescript-eslint/no-unused-vars": [
+                "error",
+                {
+                    // Do not report unused function arguments
+                    "args": "none",
+                }
+            ],
+            // Required to import JS modules
+            "@typescript-eslint/no-var-requires": "off",
+        }
+    }
+);

examples/express-sample/app.js

@@ -1,52 +1,60 @@
-var config = require('config');
+var config = require("config");
+
+if (config.Raygun.Key === "YOUR_API_KEY") {
+  console.error("You need to set your Raygun API key in the config file");
+  process.exit(1);
+}
 
 // Setup Raygun
-var raygun = require('raygun');
+var raygun = require("raygun");
 var raygunClient = new raygun.Client().init({
-    apiKey: config.Raygun.Key
+  apiKey: config.Raygun.Key,
 });
 
-var express = require('express');
-var path = require('path');
-var favicon = require('serve-favicon');
-var logger = require('morgan');
-var cookieParser = require('cookie-parser');
-var bodyParser = require('body-parser');
-var sassMiddleware = require('node-sass-middleware');
+var express = require("express");
+var path = require("path");
+var logger = require("morgan");
+var cookieParser = require("cookie-parser");
+var bodyParser = require("body-parser");
+var sassMiddleware = require("node-sass-middleware");
 
-var routes = require('./routes/index');
-var users = require('./routes/users');
+var routes = require("./routes/index");
+var users = require("./routes/users");
 
 var app = express();
 
 // Set the user if we have one
-raygunClient.user = function(req) {
-    return '[email protected]';
+raygunClient.user = function (req) {
+  return "[email protected]";
 };
 
 // view engine setup
-app.set('views', path.join(__dirname, 'views'));
-app.set('view engine', 'ejs');
+app.set("views", path.join(__dirname, "views"));
+app.set("view engine", "ejs");
 
 // uncomment after placing your favicon in /public
 //app.use(favicon(__dirname + '/public/favicon.ico'));
-app.use(logger('dev'));
+app.use(logger("dev"));
 app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({
-    extended: false
-}));
+app.use(
+  bodyParser.urlencoded({
+    extended: false,
+  }),
+);
 app.use(cookieParser());
-app.use(sassMiddleware({
-  src: __dirname,
-  dest: path.join(__dirname, 'public'),
-  debug: true,
-  outputStyle: 'compressed',
-  prefix: '/stylesheets'
-}));
-app.use(express.static(path.join(__dirname, 'public')));
-
-app.use('/', routes);
-app.use('/users', users);
+app.use(
+  sassMiddleware({
+    src: __dirname,
+    dest: path.join(__dirname, "public"),
+    debug: true,
+    outputStyle: "compressed",
+    prefix: "/stylesheets",
+  }),
+);
+app.use(express.static(path.join(__dirname, "public")));
+
+app.use("/", routes);
+app.use("/users", users);
 
 // Add the Raygun Express handler
 app.use(raygunClient.expressHandler);