chore: modernize the package (#450)

Author: AlCalzone

.github/workflows/codeql-analysis.yml

@@ -25,7 +25,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v6
       with:
         # We must fetch at least the immediate parents so that if this is
         # a pull request then we can checkout the head.
@@ -38,14 +38,14 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v4
       with:
         languages: ${{ matrix.language }}
 
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v4
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -59,4 +59,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v4

.github/workflows/dependabot-automerge.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v6
 
       - name: Check if PR should be auto-merged
         uses: ahmadnassri/action-dependabot-auto-merge@v2

.github/workflows/test-and-release.yml

@@ -1,80 +1,81 @@
+# This is a composition of lint and test scripts
+
 name: Test and Release
 
 # Run this job on all pushes and pull requests
 # as well as tags with a semantic version
 on:
-    push:
-        branches:
-          - master
-        tags:
-          # normal versions
-          - "v[0-9]+.[0-9]+.[0-9]+"
-          # pre-releases
-          - "v[0-9]+.[0-9]+.[0-9]+-**"
-    pull_request: {}
+  push:
+      branches:
+        - master
+      tags:
+        # normal versions
+        - "v[0-9]+.[0-9]+.[0-9]+"
+        # pre-releases
+        - "v[0-9]+.[0-9]+.[0-9]+-**"
+  pull_request: {}
+
+permissions:
+  id-token: write # Required for publishing with OIDC
+  contents: write # Required for creating releases
 
 jobs:
   # Performs quick checks before the expensive test runs
   check-and-lint:
-    if: contains(github.event.head_commit.message, '[skip ci]') == false
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [24]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
+      - uses: actions/checkout@v6
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
 
-    - name: Install dependencies
-      run: npm ci
+      - name: Install dependencies
+        run: npm ci
 
-    - name: Lint TypeScript code
-      run: npm run lint
+      - name: Lint TypeScript code
+        run: npm run lint
 
-    - name: Compile TypeScript code
-      run: npm run build
+      - name: Compile TypeScript code
+        run: npm run build
 
   # ===================
 
   # Runs unit tests on all supported node versions and OSes
   unit-tests:
-    if: contains(github.event.head_commit.message, '[skip ci]') == false
-
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x, 18.x]
-        os: [ubuntu-latest]
+        node-version: [22, 24]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-
-    - name: Install dependencies
-      run: npm ci
-
-    - name: Run component tests
-      run: npm run test:ts
-      env:
-        CI: true
+      - uses: actions/checkout@v6
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run component tests
+        # Some tests are flaky, try them 3 times if necessary
+        run: npm run test:ts || npm run test:ts || npm run test:ts
+        env:
+          CI: true
 
   # ===================
 
   # Deploys the final package to NPM
   deploy:
     # Trigger this step only when a commit on master is tagged with a version number
     if: |
-      contains(github.event.head_commit.message, '[skip ci]') == false &&
       github.event_name == 'push' &&
       startsWith(github.ref, 'refs/tags/v')
 
@@ -83,51 +84,51 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [24]
 
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v3
-
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-
-    - name: Extract the version and commit body from the tag
-      id: extract_release
-      # The body may be multiline, therefore we need to escape some characters
-      run: |
-        VERSION="${{ github.ref }}"
-        VERSION=${VERSION##*/v}
-        echo "::set-output name=VERSION::$VERSION"
-        BODY=$(git show -s --format=%b)
-        BODY="${BODY//'%'/'%25'}"
-        BODY="${BODY//$'\n'/'%0A'}"
-        BODY="${BODY//$'\r'/'%0D'}"
-        echo "::set-output name=BODY::$BODY"
-
-    - name: Install dependencies
-      run: npm ci
-
-    - name: Create a clean build
-      run: npm run build
-
-    - name: Publish package to npm
-      run: |
-        npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
-        npm whoami
-        npm publish
-
-    - name: Create Github Release
-      uses: actions/create-release@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        tag_name: ${{ github.ref }}
-        release_name: Release v${{ steps.extract_release.outputs.VERSION }}
-        draft: false
-        # Prerelease versions create prereleases on Github
-        prerelease: ${{ contains(steps.extract_release.outputs.VERSION, '-') }}
-        body: ${{ steps.extract_release.outputs.BODY }}
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Extract the version and commit body from the tag
+        id: extract_release
+        # The body may be multiline, therefore we need to escape some characters
+        run: |
+          VERSION="${{ github.ref }}"
+          VERSION=${VERSION##*/v}
+          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+          EOF=$(od -An -N6 -x /dev/urandom | tr -d ' ')
+          BODY=$(git show -s --format=%b)
+          echo "BODY<<$EOF" >> $GITHUB_OUTPUT
+          echo "$BODY" >> $GITHUB_OUTPUT
+          echo "$EOF" >> $GITHUB_OUTPUT
+          if [[ $VERSION == *"-"* ]] ; then
+            echo "TAG=--tag next" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Create a clean build
+        run: npm run build
+
+      - name: Publish package to npm
+        run: npm publish ${{ steps.extract_release.outputs.TAG }}
+
+      - name: Create Github Release
+        uses: softprops/action-gh-release@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          name: Release v${{ steps.extract_release.outputs.VERSION }}
+          draft: false
+          # Prerelease versions create prereleases on Github
+          prerelease: ${{ contains(steps.extract_release.outputs.VERSION, '-') }}
+          body: ${{ steps.extract_release.outputs.BODY }}

.gitignore

@@ -193,6 +193,7 @@ ClientBin/
 *.pfx
 *.publishsettings
 node_modules/
+build/
 orleans.codegen.cs
 
 # Since there are multiple workflows, uncomment next line to ignore bower_components

.lgtm.yml

@@ -10,7 +10,7 @@ Clientside implementation of the CoAP protocol with DTLS support
 
 ## Usage
 ```ts
-const coap = require("node-coap-client").CoapClient;
+import { CoapClient as coap } from "node-coap-client";
 ```
 The CoAP client provides the following public methods:
 
@@ -174,6 +174,13 @@ To only reset connections and requests for a specific hostname, pass the hostnam
     PLACEHOLDER for next version:
     ### __WORK IN PROGRESS__
 -->
+### __WORK IN PROGRESS__
+* Node.js 22+ is now required
+* This package is now pure ESM
+* Replaced Mocha/Chai/Sinon with Vitest
+* Replaced TSLint with Oxlint
+* Bumped `node-dtls-client` to v2
+
 ### 2.1.0 (2023-01-26)
 * (AlCalzone) Updated the `node-dtls-client` dependency for proper Electron support