fix: archive repository

This project is not anymore maintained.

.eslintrc.json

@@ -0,0 +1,16 @@
+{
+  "extends": ["conventions", "prettier"],
+  "plugins": ["prettier", "import", "unicorn"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "env": {
+    "node": true
+  },
+  "rules": {
+    "prettier/prettier": "error",
+    "import/extensions": ["error", "always"],
+    "unicorn/prefer-node-protocol": "error"
+  }
+}

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/ISSUE_TEMPLATE/BUG.md

@@ -1,8 +1,8 @@
 ---
-name: '🐛 Bug Report'
+name: "🐛 Bug Report"
-about: 'Report an unexpected problem or unintended behavior.'
+about: "Report an unexpected problem or unintended behavior."
-title: '[Bug]'
+title: "[Bug]"
-labels: 'bug'
+labels: "bug"
 ---
 
 <!--

.github/ISSUE_TEMPLATE/DOCUMENTATION.md

@@ -1,8 +1,8 @@
 ---
-name: '📜 Documentation'
+name: "📜 Documentation"
-about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).'
+about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)."
-title: '[Documentation]'
+title: "[Documentation]"
-labels: 'documentation'
+labels: "documentation"
 ---
 
 <!-- Please make sure your issue has not already been fixed. -->

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -1,8 +1,8 @@
 ---
-name: '✨ Feature Request'
+name: "✨ Feature Request"
-about: 'Suggest a new feature idea.'
+about: "Suggest a new feature idea."
-title: '[Feature]'
+title: "[Feature]"
-labels: 'feature request'
+labels: "feature request"
 ---
 
 <!-- Please make sure your issue has not already been fixed. -->

.github/ISSUE_TEMPLATE/IMPROVEMENT.md

@@ -1,8 +1,8 @@
 ---
-name: '🔧 Improvement'
+name: "🔧 Improvement"
-about: 'Improve structure/format/performance/refactor/tests of the code.'
+about: "Improve structure/format/performance/refactor/tests of the code."
-title: '[Improvement]'
+title: "[Improvement]"
-labels: 'improvement'
+labels: "improvement"
 ---
 
 <!-- Please make sure your issue has not already been fixed. -->

.github/ISSUE_TEMPLATE/QUESTION.md

@@ -1,8 +1,8 @@
 ---
-name: '🙋 Question'
+name: "🙋 Question"
-about: 'Further information is requested.'
+about: "Further information is requested."
-title: '[Question]'
+title: "[Question]"
-labels: 'question'
+labels: "question"
 ---
 
 ### Question

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 <!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
 
-## What changes this PR introduce?
+# What changes this PR introduce?
 
 ## List any relevant issue numbers
 

.github/dependabot.yml

@@ -1,11 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: 'github-actions'
-    directory: '/'
-    schedule:
-      interval: 'daily'
-
-  - package-ecosystem: 'npm'
-    directory: '/'
-    schedule:
-      interval: 'daily'

.github/workflows/build.yml

@@ -1,25 +1,27 @@
-name: 'Build'
+name: "Build"
 
 on:
   push:
-    branches: [master, develop]
+    branches: [develop]
   pull_request:
     branches: [master, develop]
 
 jobs:
   build:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: "actions/checkout@v4.0.0"
 
-      - name: 'Use Node.js'
+      - name: "Setup Node.js"
-        uses: 'actions/setup-node@v2.3.0'
+        uses: "actions/setup-node@v3.8.1"
         with:
-          node-version: '16.x'
+          node-version: "20.x"
-          cache: 'npm'
+          cache: "npm"
 
-      - name: 'Install'
+      - name: "Install dependencies"
-        run: 'npm install'
+        run: "npm clean-install"
 
-      - name: 'Build Package'
+      - name: "Build"
-        run: 'npm run build'
+        run: "npm run build"
+
+      - run: "npm run build:typescript"

.github/workflows/lint.yml

@@ -1,27 +1,28 @@
-name: 'Lint'
+name: "Lint"
 
 on:
   push:
-    branches: [master, develop]
+    branches: [develop]
   pull_request:
     branches: [master, develop]
 
 jobs:
   lint:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: "actions/checkout@v4.0.0"
 
-      - name: 'Use Node.js'
+      - name: "Setup Node.js"
-        uses: 'actions/setup-node@v2.3.0'
+        uses: "actions/setup-node@v3.8.1"
         with:
-          node-version: '16.x'
+          node-version: "20.x"
-          cache: 'npm'
+          cache: "npm"
 
-      - name: 'Install'
+      - name: "Install dependencies"
-        run: 'npm install'
+        run: "npm clean-install"
 
       - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
-      - run: 'npm run lint:editorconfig'
+      - run: "npm run lint:editorconfig"
-      - run: 'npm run lint:markdown'
+      - run: "npm run lint:markdown"
-      - run: 'npm run lint:typescript'
+      - run: "npm run lint:eslint"
+      - run: "npm run lint:prettier"

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: 'Release'
+name: "Release"
 
 on:
   push:
@@ -6,24 +6,34 @@ on:
 
 jobs:
   release:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
+    permissions:
+      contents: "write"
+      issues: "write"
+      pull-requests: "write"
+      id-token: "write"
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: "actions/checkout@v4.0.0"
 
-      - name: 'Use Node.js'
+      - name: "Setup Node.js"
-        uses: 'actions/setup-node@v2.3.0'
+        uses: "actions/setup-node@v3.8.1"
         with:
-          node-version: '16.x'
+          node-version: "20.x"
-          cache: 'npm'
+          cache: "npm"
 
-      - name: 'Install'
+      - name: "Install dependencies"
-        run: 'npm install'
+        run: "npm clean-install"
 
-      - name: 'Build Package'
+      - name: "Build Package"
-        run: 'npm run build'
+        run: "npm run build"
 
-      - name: 'Release'
+      - run: "npm run build:typescript"
-        run: 'npm run release'
+
+      - name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
+        run: "npm audit signatures"
+
+      - name: "Release"
+        run: "npm run release"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -1,28 +1,28 @@
-name: 'Test'
+name: "Test"
 
 on:
   push:
-    branches: [master, develop]
+    branches: [develop]
   pull_request:
     branches: [master, develop]
 
 jobs:
   test:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: "actions/checkout@v4.0.0"
 
-      - name: 'Use Node.js'
+      - name: "Setup Node.js"
-        uses: 'actions/setup-node@v2.3.0'
+        uses: "actions/setup-node@v3.8.1"
         with:
-          node-version: '16.x'
+          node-version: "20.x"
-          cache: 'npm'
+          cache: "npm"
 
-      - name: 'Install'
+      - name: "Install dependencies"
-        run: 'npm install'
+        run: "npm clean-install"
 
-      - name: 'Test'
+      - name: "Build"
-        run: 'npm run test'
+        run: "npm run build"
 
-      - name: 'Upload Coverage'
+      - name: "Test"
-        uses: 'codecov/codecov-action@v2.0.1'
+        run: "npm run test"

.gitignore

@@ -6,17 +6,30 @@ node_modules
 
 # production
 build
+.swc
 
 # testing
 coverage
+.nyc_output
 
 # debug
 npm-debug.log*
 
-# editors
+# IDEs and editors
-.vscode
+/.idea
-.theia
+.project
-.idea
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
 
 # misc
 .DS_Store

.husky/pre-commit

@@ -1,7 +1,6 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npm run lint:editorconfig
+npm run lint:staged
-npm run lint:markdown
-npm run lint:typescript
 npm run build
+npm run build:typescript

.lintstagedrc.json

@@ -0,0 +1,6 @@
+{
+  "*": ["editorconfig-checker"],
+  "*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
+  "*.{json,jsonc,yml,yaml}": ["prettier --write"],
+  "*.{md,mdx}": ["prettier --write", "markdownlint-cli2 --fix"]
+}

.markdownlint-cli2.jsonc

@@ -0,0 +1,11 @@
+{
+  "config": {
+    "extends": "markdownlint/style/prettier",
+    "relative-links": true,
+    "default": true,
+    "MD033": false
+  },
+  "globs": ["**/*.{md,mdx}"],
+  "ignores": ["**/node_modules"],
+  "customRules": ["markdownlint-rule-relative-links"]
+}

.markdownlint.json

@@ -1,7 +0,0 @@
-{
-  "default": true,
-  "MD013": false,
-  "MD024": false,
-  "MD033": false,
-  "MD041": false
-}

.npmrc

@@ -1 +1,2 @@
 save-exact=true
+provenance=true

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "semi": false
+}

.swcrc

@@ -0,0 +1,13 @@
+{
+  "sourceMaps": true,
+  "jsc": {
+    "parser": {
+      "syntax": "typescript",
+      "dynamicImport": true
+    },
+    "target": "esnext"
+  },
+  "module": {
+    "type": "es6"
+  }
+}

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "editorconfig.editorconfig",
+    "esbenp.prettier-vscode",
+    "dbaeumer.vscode-eslint",
+    "davidanson.vscode-markdownlint"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.preferences.importModuleSpecifierEnding": "js",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "prettier.configPath": ".prettierrc.json",
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true
+  },
+  "eslint.options": { "ignorePath": ".gitignore" }
+}

CHANGELOG.md

@@ -1,71 +0,0 @@
-# Changelog
-
-## [2.1.0](https://github.com/Thream/socketio-jwt/compare/v2.0.0...v2.1.0) (2021-03-08)
-
-### Features
-
-- add optional `onAuthentication` option to add `user` property in `socket` object ([#62](https://github.com/Thream/socketio-jwt/issues/62)) ([c7f64a6](https://github.com/Thream/socketio-jwt/commit/c7f64a6312a3e1f6f04918cb7cd415ddef7a11e5))
-
-## [2.0.0](https://github.com/Thream/socketio-jwt/compare/v1.1.1...v2.0.0) (2021-02-22)
-
-### Features
-
-- usage of auth option to send credentials ([a14d4e9](https://github.com/Thream/socketio-jwt/commit/a14d4e937b764fdf4fb6b173c55b6f49688766dd))
-
-  See: <https://socket.io/docs/v3/middlewares/#Sending-credentials>
-
-### BREAKING CHANGES
-
-- `extraHeaders` with `Authorization` doesn't work anymore
-
-### Migration
-
-You need to change the way to connect client side.
-
-Before :
-
-```ts
-import { io } from 'socket.io-client'
-
-const socket = io('http://localhost:9000', {
-  extraHeaders: { Authorization: `Bearer ${yourJWT}` }
-})
-```
-
-After :
-
-```ts
-import { io } from 'socket.io-client'
-
-const socket = io('http://localhost:9000', {
-  auth: { token: `Bearer ${yourJWT}` }
-})
-```
-
-## [1.1.1](https://github.com/Thream/socketio-jwt/compare/v1.1.0...v1.1.1) (2021-01-28)
-
-### Bug Fixes
-
-- **types:** decodedToken in secret callback ([c1a9213](https://github.com/Thream/socketio-jwt/commit/c1a9213a527e4c6188328221372e1f40191a790e)), closes [#21](https://github.com/Thream/socketio-jwt/issues/21)
-
-### Documentation
-
-- update server side usage with `jwks-rsa` : get the secret with `key.getPublicKey()` instead of `key.rsaPublicKey`
-
-## [1.1.0](https://github.com/Thream/socketio-jwt/compare/v1.0.1...v1.1.0) (2021-01-07)
-
-### Features
-
-- add algorithms option ([abbabc5](https://github.com/Thream/socketio-jwt/commit/abbabc588e3ea8b906fa0a0dcc83c91a3b5b5ea8))
-- add support for jwks-rsa ([#1](https://github.com/Thream/socketio-jwt/issues/1)) ([261e8d6](https://github.com/Thream/socketio-jwt/commit/261e8d66e2ec6fefb77429abcef8f846d996ecac))
-- improve types by extending socket.io module ([#6](https://github.com/Thream/socketio-jwt/issues/6)) ([84b523f](https://github.com/Thream/socketio-jwt/commit/84b523f4348c81933887f0dc700f438c84bd779a))
-
-## [1.0.1](https://github.com/Thream/socketio-jwt/compare/v1.0.0...v1.0.1) (2020-12-29)
-
-### Documentation
-
-- fix usage section by correctly importing `authorize`
-
-## [1.0.0](https://github.com/Thream/socketio-jwt/compare/v4.6.2...v1.0.0) (2020-12-29)
-
-Initial release.

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-contact@divlo.fr.
+<contact@theoludwig.fr>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -21,7 +21,7 @@ All work on **Thream** happens directly on [GitHub](https://github.com/Thream).
 
 - **Please first discuss** the change you wish to make via [issue](https://github.com/Thream/socketio-jwt/issues) before making a change. It might avoid a waste of your time.
 
-- Ensure your code respect [Typescript Standard Style](https://www.npmjs.com/package/ts-standard).
+- Ensure your code respect linting.
 
 - Make sure your **code passes the tests**.
 
@@ -29,26 +29,4 @@ If you're adding new features to **Thream/socketio-jwt**, please include tests.
 
 ## Commits
 
-The commit message guidelines respect [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) and [Semantic Versioning](https://semver.org/) for releases.
+The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
-
-### Types
-
-Types define which kind of changes you made to the project.
-
-| Types    | Description                                                                                                  |
-| -------- | ------------------------------------------------------------------------------------------------------------ |
-| feat     | A new feature.                                                                                               |
-| fix      | A bug fix.                                                                                                   |
-| docs     | Documentation only changes.                                                                                  |
-| style    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).      |
-| refactor | A code change that neither fixes a bug nor adds a feature.                                                   |
-| perf     | A code change that improves performance.                                                                     |
-| test     | Adding missing tests or correcting existing tests.                                                           |
-| build    | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).         |
-| ci       | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
-| chore    | Other changes that don't modify src or test files.                                                           |
-| revert   | Reverts a previous commit.                                                                                   |
-
-### Scopes
-
-Scopes define what part of the code changed.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Auth0, Inc. <support@auth0.com> (http://auth0.com) and Thream contributors
+Copyright (c) Auth0, Inc. <support@auth0.com> (<https://auth0.com/>) and Thream contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,16 +4,18 @@
   <strong>Authenticate socket.io incoming connections with JWTs.</strong>
 </p>
 
+<p align="center">
+  <strong>⚠️ This project is not maintained anymore, you can still use the code as you wish and fork it to maintain it yourself.</strong>
+</p>
+
 <p align="center">
   <a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a>
   <a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a>
   <a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
-  <a href="https://dependabot.com/"><img src="https://badgen.net/github/dependabot/Thream/socketio-jwt?icon=dependabot" alt="Dependabot badge" /></a>
   <br/>
   <a href="https://github.com/Thream/socketio-jwt/actions/workflows/build.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/build.yml/badge.svg?branch=develop" /></a>
   <a href="https://github.com/Thream/socketio-jwt/actions/workflows/lint.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
   <a href="https://github.com/Thream/socketio-jwt/actions/workflows/test.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
-  <a href="https://codecov.io/gh/Thream/socketio-jwt"><img src="https://codecov.io/gh/Thream/socketio-jwt/branch/develop/graph/badge.svg" alt="codecov" /></a>
   <br />
   <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a>
   <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a>
@@ -24,12 +26,17 @@
 
 Authenticate socket.io incoming connections with JWTs.
 
-Compatible with `socket.io >= 3.0.0`.
+This repository was originally forked from [auth0-socketio-jwt](https://github.com/auth0-community/auth0-socketio-jwt) and it is not intended to take any credit but to improve the code from now on.
 
-This repository was originally forked from [auth0-socketio-jwt](https://github.com/auth0-community/auth0-socketio-jwt) & it is not intended to take any credit but to improve the code from now on.
+## Prerequisites
+
+- [Node.js](https://nodejs.org/) >= 16.0.0
+- [Socket.IO](https://socket.io/) >= 3.0.0
 
 ## 💾 Install
 
+**Note:** It is a package that is recommended to use/install on both the client and server sides.
+
 ```sh
 npm install --save @thream/socketio-jwt
 ```
@@ -39,24 +46,24 @@ npm install --save @thream/socketio-jwt
 ### Server side
 
 ```ts
-import { Server } from 'socket.io'
+import { Server } from "socket.io"
-import { authorize } from '@thream/socketio-jwt'
+import { authorize } from "@thream/socketio-jwt"
 
 const io = new Server(9000)
 io.use(
   authorize({
-    secret: 'your secret or public key'
+    secret: "your secret or public key",
-  })
+  }),
 )
 
-io.on('connection', async (socket) => {
+io.on("connection", async (socket) => {
   // jwt payload of the connected client
   console.log(socket.decodedToken)
   const clients = await io.sockets.allSockets()
   if (clients != null) {
     for (const clientId of clients) {
       const client = io.sockets.sockets.get(clientId)
-      client?.emit('messages', { message: 'Success!' })
+      client?.emit("messages", { message: "Success!" })
       // we can access the jwt payload of each connected client
       console.log(client?.decodedToken)
     }
@@ -67,12 +74,12 @@ io.on('connection', async (socket) => {
 ### Server side with `jwks-rsa` (example)
 
 ```ts
-import jwksClient from 'jwks-rsa'
+import jwksClient from "jwks-rsa"
-import { Server } from 'socket.io'
+import { Server } from "socket.io"
-import { authorize } from '@thream/socketio-jwt'
+import { authorize } from "@thream/socketio-jwt"
 
 const client = jwksClient({
-  jwksUri: 'https://sandrino.auth0.com/.well-known/jwks.json'
+  jwksUri: "https://sandrino.auth0.com/.well-known/jwks.json",
 })
 
 const io = new Server(9000)
@@ -81,11 +88,11 @@ io.use(
     secret: async (decodedToken) => {
       const key = await client.getSigningKeyAsync(decodedToken.header.kid)
       return key.getPublicKey()
-    }
+    },
-  })
+  }),
 )
 
-io.on('connection', async (socket) => {
+io.on("connection", async (socket) => {
   // jwt payload of the connected client
   console.log(socket.decodedToken)
   // You can do the same things of the previous example there...
@@ -95,21 +102,21 @@ io.on('connection', async (socket) => {
 ### Server side with `onAuthentication` (example)
 
 ```ts
-import { Server } from 'socket.io'
+import { Server } from "socket.io"
-import { authorize } from '@thream/socketio-jwt'
+import { authorize } from "@thream/socketio-jwt"
 
 const io = new Server(9000)
 io.use(
   authorize({
-    secret: 'your secret or public key',
+    secret: "your secret or public key",
-    onAuthentication: async decodedToken => {
+    onAuthentication: async (decodedToken) => {
       // return the object that you want to add to the user property
       // or throw an error if the token is unauthorized
-    }
+    },
-  })
+  }),
 )
 
-io.on('connection', async (socket) => {
+io.on("connection", async (socket) => {
   // jwt payload of the connected client
   console.log(socket.decodedToken)
   // You can do the same things of the previous example there...
@@ -127,22 +134,23 @@ io.on('connection', async (socket) => {
 ### Client side
 
 ```ts
-import { io } from 'socket.io-client'
+import { io } from "socket.io-client"
+import { isUnauthorizedError } from "@thream/socketio-jwt/build/UnauthorizedError.js"
 
 // Require Bearer Token
-const socket = io('http://localhost:9000', {
+const socket = io("http://localhost:9000", {
-  auth: { token: `Bearer ${yourJWT}` }
+  auth: { token: `Bearer ${yourJWT}` },
 })
 
 // Handling token expiration
-socket.on('connect_error', (error) => {
+socket.on("connect_error", (error) => {
-  if (error.data.type === 'UnauthorizedError') {
+  if (isUnauthorizedError(error)) {
-    console.log('User token has expired')
+    console.log("User token has expired")
   }
 })
 
 // Listening to events
-socket.on('messages', (data) => {
+socket.on("messages", (data) => {
   console.log(data)
 })
 ```

jest.config.js

@@ -1,8 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  rootDir: './src',
-  setupFilesAfterEnv: ['<rootDir>/__test__/setup.ts'],
-  collectCoverage: true,
-  coverageDirectory: '../coverage/'
-}

package.json

@@ -1,50 +1,52 @@
 {
   "name": "@thream/socketio-jwt",
   "version": "0.0.0-development",
+  "type": "module",
+  "public": true,
   "description": "Authenticate socket.io incoming connections with JWTs.",
   "license": "MIT",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [
-    "build"
+    "build",
+    "!**/*.test.js",
+    "!**/*.test.d.ts",
+    "!**/*.map"
   ],
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=16.0.0",
+    "npm": ">=9.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
   },
   "keywords": [
     "socket",
     "socket.io",
     "jwt"
   ],
-  "author": "Divlo <contact@divlo.fr>",
+  "author": "Théo LUDWIG <contact@theoludwig.fr>",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Thream/socketio-jwt"
+    "url": "https://github.com/Thream/socketio-jwt"
   },
   "bugs": {
     "url": "https://github.com/Thream/socketio-jwt/issues"
   },
   "homepage": "https://github.com/Thream/socketio-jwt#readme",
-  "ts-standard": {
-    "ignore": [
-      "build",
-      "coverage",
-      "node_modules"
-    ],
-    "envs": [
-      "node",
-      "jest"
-    ],
-    "report": "stylish"
-  },
   "scripts": {
-    "build": "rimraf ./build && tsc",
+    "build": "rimraf ./build && swc ./src --out-dir ./build",
+    "build:dev": "swc ./src --out-dir ./build --watch",
+    "build:typescript": "tsc",
     "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
-    "lint:markdown": "markdownlint '**/*.md' --dot --ignore node_modules",
+    "lint:markdown": "markdownlint-cli2",
-    "lint:typescript": "ts-standard",
+    "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
+    "lint:prettier": "prettier . --check",
+    "lint:staged": "lint-staged",
+    "test": "cross-env NODE_ENV=test node --enable-source-maps --test build/",
     "release": "semantic-release",
-    "test": "jest",
     "postinstall": "husky install",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable"
@@ -53,30 +55,39 @@
     "socket.io": ">=3.0.0"
   },
   "dependencies": {
-    "jsonwebtoken": "8.5.1"
+    "jsonwebtoken": "9.0.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "12.1.4",
+    "@commitlint/cli": "18.0.0",
-    "@commitlint/config-conventional": "12.1.4",
+    "@commitlint/config-conventional": "18.0.0",
-    "@types/express": "4.17.13",
+    "@swc/cli": "0.1.62",
-    "@types/jest": "26.0.24",
+    "@swc/core": "1.3.94",
-    "@types/jsonwebtoken": "8.5.4",
+    "@tsconfig/strictest": "2.0.2",
-    "@types/node": "16.4.1",
+    "@types/jsonwebtoken": "9.0.4",
-    "@types/server-destroy": "1.0.1",
+    "@types/node": "20.8.7",
-    "axios": "0.21.1",
+    "@typescript-eslint/eslint-plugin": "6.9.0",
-    "editorconfig-checker": "4.0.2",
+    "@typescript-eslint/parser": "6.9.0",
-    "express": "4.17.1",
+    "axios": "1.5.1",
-    "husky": "7.0.1",
+    "cross-env": "7.0.3",
-    "jest": "27.0.6",
+    "editorconfig-checker": "5.1.1",
-    "markdownlint-cli": "0.28.1",
+    "eslint": "8.52.0",
-    "pinst": "2.1.6",
+    "eslint-config-conventions": "12.0.0",
-    "rimraf": "3.0.2",
+    "eslint-config-prettier": "9.0.0",
-    "semantic-release": "17.4.4",
+    "eslint-plugin-import": "2.29.0",
-    "server-destroy": "1.0.1",
+    "eslint-plugin-prettier": "5.0.1",
-    "socket.io": "4.1.3",
+    "eslint-plugin-promise": "6.1.1",
-    "socket.io-client": "4.1.3",
+    "eslint-plugin-unicorn": "48.0.1",
-    "ts-jest": "27.0.4",
+    "fastify": "4.24.3",
-    "ts-standard": "10.0.0",
+    "husky": "8.0.3",
-    "typescript": "4.3.5"
+    "lint-staged": "15.0.2",
+    "markdownlint-cli2": "0.10.0",
+    "markdownlint-rule-relative-links": "2.1.0",
+    "pinst": "3.0.0",
+    "prettier": "3.0.3",
+    "rimraf": "5.0.5",
+    "semantic-release": "22.0.5",
+    "socket.io": "4.7.2",
+    "socket.io-client": "4.7.2",
+    "typescript": "5.2.2"
   }
 }

src/UnauthorizedError.ts

@@ -1,16 +1,30 @@
 export class UnauthorizedError extends Error {
   public inner: { message: string }
-  public data: { message: string, code: string, type: 'UnauthorizedError' }
+  public data: { message: string; code: string; type: "UnauthorizedError" }
 
-  constructor (code: string, error: { message: string }) {
+  constructor(code: string, error: { message: string }) {
     super(error.message)
-    this.message = error.message
+    this.name = "UnauthorizedError"
     this.inner = error
     this.data = {
       message: this.message,
       code,
-      type: 'UnauthorizedError'
+      type: "UnauthorizedError",
     }
     Object.setPrototypeOf(this, UnauthorizedError.prototype)
   }
 }
+
+export const isUnauthorizedError = (
+  error: unknown,
+): error is UnauthorizedError => {
+  return (
+    typeof error === "object" &&
+    error != null &&
+    "data" in error &&
+    typeof error.data === "object" &&
+    error.data != null &&
+    "type" in error.data &&
+    error.data.type === "UnauthorizedError"
+  )
+}

src/__test__/authorize.test.ts

@@ -1,266 +1,340 @@
-import axios from 'axios'
+import test from "node:test"
-import { io } from 'socket.io-client'
+import assert from "node:assert/strict"
 
-import { fixtureStart, fixtureStop, getSocket, Profile } from './fixture'
+import axios from "axios"
+import type { Socket } from "socket.io-client"
+import { io } from "socket.io-client"
 
-describe('authorize - with secret as string in options', () => {
+import { isUnauthorizedError } from "../UnauthorizedError.js"
-  let token: string = ''
+import type { Profile } from "./fixture/index.js"
+import {
+  API_URL,
+  fixtureStart,
+  fixtureStop,
+  getSocket,
+  basicProfile,
+} from "./fixture/index.js"
 
-  beforeEach((done) => {
+export const api = axios.create({
-    fixtureStart(async () => {
+  baseURL: API_URL,
-      const response = await axios.post('http://localhost:9000/login')
+  headers: {
-      token = response.data.token
+    "Content-Type": "application/json",
-    })
+  },
-      .then(done)
-      .catch((error) => {
-        done(error)
-      })
-  })
-
-  afterEach((done) => {
-    fixtureStop(done)
-  })
-
-  it('should emit error with no token provided', (done) => {
-    const socket = io('http://localhost:9000')
-    socket.on('connect_error', (err: any) => {
-      expect(err.data.message).toEqual('no token provided')
-      expect(err.data.code).toEqual('credentials_required')
-      socket.close()
-      done()
-    })
-  })
-
-  it('should emit error with bad token format', (done) => {
-    const socket = io('http://localhost:9000', {
-      auth: { token: 'testing' }
-    })
-    socket.on('connect_error', (err: any) => {
-      expect(err.data.message).toEqual(
-        'Format is Authorization: Bearer [token]'
-      )
-      expect(err.data.code).toEqual('credentials_bad_format')
-      socket.close()
-      done()
-    })
-  })
-
-  it('should emit error with unauthorized handshake', (done) => {
-    const socket = io('http://localhost:9000', {
-      auth: { token: 'Bearer testing' }
-    })
-    socket.on('connect_error', (err: any) => {
-      expect(err.data.message).toEqual(
-        'Unauthorized: Token is missing or invalid Bearer'
-      )
-      expect(err.data.code).toEqual('invalid_token')
-      socket.close()
-      done()
-    })
-  })
-
-  it('should connect the user', (done) => {
-    const socket = io('http://localhost:9000', {
-      auth: { token: `Bearer ${token}` }
-    })
-    socket.on('connect', () => {
-      socket.close()
-      done()
-    })
-    socket.on('connect_error', (err: any) => {
-      done(err)
-    })
-  })
 })
 
 const secretCallback = async (): Promise<string> => {
-  return 'somesecret'
+  return "somesecret"
 }
 
-describe('authorize - with secret as callback in options', () => {
+await test("authorize", async (t) => {
-  let token: string = ''
+  await t.test("with secret as string in options", async (t) => {
+    let token = ""
+    let socket: Socket | null = null
 
-  beforeEach((done) => {
+    t.beforeEach(async () => {
-    fixtureStart(
+      await fixtureStart()
-      async () => {
+      const response = await api.post("/login", {})
-        const response = await axios.post('http://localhost:9000/login')
       token = response.data.token
-      },
+    })
-      { secret: secretCallback }
+
+    t.afterEach(async () => {
+      socket?.disconnect()
+      await fixtureStop()
+    })
+
+    await t.test("should emit error with no token provided", () => {
+      socket = io(API_URL)
+      socket.on("connect_error", async (error) => {
+        assert.strictEqual(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          assert.strictEqual(error.data.message, "no token provided")
+          assert.strictEqual(error.data.code, "credentials_required")
+          assert.ok(true)
+        } else {
+          assert.fail("should be unauthorized error")
+        }
+      })
+      socket.on("connect", async () => {
+        assert.fail("should not connect")
+      })
+    })
+
+    await t.test("should emit error with bad token format", () => {
+      socket = io(API_URL, {
+        auth: { token: "testing" },
+      })
+      socket.on("connect_error", async (error) => {
+        assert.strictEqual(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          assert.strictEqual(
+            error.data.message,
+            "Format is Authorization: Bearer [token]",
           )
-      .then(done)
+          assert.strictEqual(error.data.code, "credentials_bad_format")
-      .catch((error) => {
+          assert.ok(true)
-        done(error)
+        } else {
+          assert.fail("should be unauthorized error")
+        }
+      })
+      socket.on("connect", async () => {
+        assert.fail("should not connect")
       })
     })
 
-  afterEach((done) => {
+    await t.test("should emit error with unauthorized handshake", () => {
-    fixtureStop(done)
+      socket = io(API_URL, {
+        auth: { token: "Bearer testing" },
       })
-
+      socket.on("connect_error", async (error) => {
-  it('should emit error with no token provided', (done) => {
+        assert.strictEqual(isUnauthorizedError(error), true)
-    const socket = io('http://localhost:9000')
+        if (isUnauthorizedError(error)) {
-    socket.on('connect_error', (err: any) => {
+          assert.strictEqual(
-      expect(err.data.message).toEqual('no token provided')
+            error.data.message,
-      expect(err.data.code).toEqual('credentials_required')
+            "Unauthorized: Token is missing or invalid Bearer",
-      socket.close()
-      done()
-    })
-  })
-
-  it('should emit error with bad token format', (done) => {
-    const socket = io('http://localhost:9000', {
-      auth: { token: 'testing' }
-    })
-    socket.on('connect_error', (err: any) => {
-      expect(err.data.message).toEqual(
-        'Format is Authorization: Bearer [token]'
           )
-      expect(err.data.code).toEqual('credentials_bad_format')
+          assert.strictEqual(error.data.code, "invalid_token")
-      socket.close()
+          assert.ok(true)
-      done()
+        } else {
+          assert.fail("should be unauthorized error")
+        }
+      })
+      socket.on("connect", async () => {
+        assert.fail("should not connect")
       })
     })
 
-  it('should emit error with unauthorized handshake', (done) => {
+    await t.test("should connect the user", () => {
-    const socket = io('http://localhost:9000', {
+      socket = io(API_URL, {
-      auth: { token: 'Bearer testing' }
+        auth: { token: `Bearer ${token}` },
+      })
+      socket.on("connect", async () => {
+        assert.ok(true)
+      })
+      socket.on("connect_error", async (error) => {
+        assert.fail(error.message)
       })
-    socket.on('connect_error', (err: any) => {
-      expect(err.data.message).toEqual(
-        'Unauthorized: Token is missing or invalid Bearer'
-      )
-      expect(err.data.code).toEqual('invalid_token')
-      socket.close()
-      done()
     })
   })
 
-  it('should connect the user', (done) => {
+  await t.test("with secret as callback in options", async (t) => {
-    const socket = io('http://localhost:9000', {
+    let token = ""
-      auth: { token: `Bearer ${token}` }
+    let socket: Socket | null = null
-    })
-    socket.on('connect', () => {
-      socket.close()
-      done()
-    })
-    socket.on('connect_error', (err: any) => {
-      done(err)
-    })
-  })
-})
 
-describe('authorize - with onAuthentication callback in options', () => {
+    t.beforeEach(async () => {
-  let token: string = ''
+      await fixtureStart({ secret: secretCallback })
-  let wrongToken: string = ''
+      const response = await api.post("/login", {})
-
-  beforeEach((done) => {
-    fixtureStart(
-      async () => {
-        const response = await axios.post('http://localhost:9000/login')
       token = response.data.token
-        const responseWrong = await axios.post(
+    })
-          'http://localhost:9000/login-wrong'
+
+    t.afterEach(async () => {
+      socket?.disconnect()
+      await fixtureStop()
+    })
+
+    await t.test("should emit error with no token provided", () => {
+      socket = io(API_URL)
+      socket.on("connect_error", async (error) => {
+        assert.strictEqual(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          assert.strictEqual(error.data.message, "no token provided")
+          assert.strictEqual(error.data.code, "credentials_required")
+          assert.ok(true)
+        } else {
+          assert.fail("should be unauthorized error")
+        }
+      })
+      socket.on("connect", async () => {
+        assert.fail("should not connect")
+      })
+    })
+
+    await t.test("should emit error with bad token format", () => {
+      socket = io(API_URL, {
+        auth: { token: "testing" },
+      })
+      socket.on("connect_error", async (error) => {
+        assert.strictEqual(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          assert.strictEqual(
+            error.data.message,
+            "Format is Authorization: Bearer [token]",
           )
-        wrongToken = responseWrong.data.token
+          assert.strictEqual(error.data.code, "credentials_bad_format")
-      },
+          assert.ok(true)
-      {
+        } else {
+          assert.fail("should be unauthorized error")
+        }
+      })
+      socket.on("connect", async () => {
+        assert.fail("should not connect")
+      })
+    })
+
+    await t.test("should emit error with unauthorized handshake", () => {
+      socket = io(API_URL, {
+        auth: { token: "Bearer testing" },
+      })
+      socket.on("connect_error", async (error) => {
+        assert.strictEqual(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          assert.strictEqual(
+            error.data.message,
+            "Unauthorized: Token is missing or invalid Bearer",
+          )
+          assert.strictEqual(error.data.code, "invalid_token")
+          assert.ok(true)
+        } else {
+          assert.fail("should be unauthorized error")
+        }
+      })
+      socket.on("connect", async () => {
+        assert.fail("should not connect")
+      })
+    })
+
+    await t.test("should connect the user", () => {
+      socket = io(API_URL, {
+        auth: { token: `Bearer ${token}` },
+      })
+      socket.on("connect", async () => {
+        assert.ok(true)
+      })
+      socket.on("connect_error", async (error) => {
+        assert.fail(error.message)
+      })
+    })
+  })
+
+  await t.test("with onAuthentication callback in options", async (t) => {
+    let token = ""
+    let wrongToken = ""
+    let socket: Socket | null = null
+
+    t.beforeEach(async () => {
+      await fixtureStart({
         secret: secretCallback,
         onAuthentication: (decodedToken: Profile) => {
           if (!decodedToken.checkField) {
-            throw new Error('Check Field validation failed')
+            throw new Error("Check Field validation failed")
           }
           return {
-            email: decodedToken.email
+            email: decodedToken.email,
           }
+        },
+      })
+      const response = await api.post("/login", {})
+      token = response.data.token
+      const responseWrong = await api.post("/login-wrong", {})
+      wrongToken = responseWrong.data.token
+    })
+
+    t.afterEach(async () => {
+      socket?.disconnect()
+      await fixtureStop()
+    })
+
+    await t.test("should emit error with no token provided", () => {
+      socket = io(API_URL)
+      socket.on("connect_error", async (error) => {
+        assert.strictEqual(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          assert.strictEqual(error.data.message, "no token provided")
+          assert.strictEqual(error.data.code, "credentials_required")
+          assert.ok(true)
+        } else {
+          assert.fail("should be unauthorized error")
         }
+      })
+      socket.on("connect", async () => {
+        assert.fail("should not connect")
+      })
+    })
+
+    await t.test("should emit error with bad token format", () => {
+      socket = io(API_URL, {
+        auth: { token: "testing" },
+      })
+      socket.on("connect_error", async (error) => {
+        assert.strictEqual(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          assert.strictEqual(
+            error.data.message,
+            "Format is Authorization: Bearer [token]",
+          )
+          assert.strictEqual(error.data.code, "credentials_bad_format")
+          assert.ok(true)
+        } else {
+          assert.fail("should be unauthorized error")
         }
+      })
+      socket.on("connect", async () => {
+        assert.fail("should not connect")
+      })
+    })
+
+    await t.test("should emit error with unauthorized handshake", () => {
+      socket = io(API_URL, {
+        auth: { token: "Bearer testing" },
+      })
+      socket.on("connect_error", async (error) => {
+        assert.strictEqual(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          assert.strictEqual(
+            error.data.message,
+            "Unauthorized: Token is missing or invalid Bearer",
           )
-      .then(done)
+          assert.strictEqual(error.data.code, "invalid_token")
-      .catch((error) => {
+          assert.ok(true)
-        done(error)
+        } else {
+          assert.fail("should be unauthorized error")
+        }
+      })
+      socket.on("connect", async () => {
+        assert.fail("should not connect")
       })
     })
 
-  afterEach((done) => {
+    await t.test("should connect the user", () => {
-    fixtureStop(done)
+      socket = io(API_URL, {
+        auth: { token: `Bearer ${token}` },
       })
-
+      socket.on("connect", async () => {
-  it('should emit error with no token provided', (done) => {
+        assert.ok(true)
-    const socket = io('http://localhost:9000')
+      })
-    socket.on('connect_error', (err: any) => {
+      socket.on("connect_error", async (error) => {
-      expect(err.data.message).toEqual('no token provided')
+        assert.fail(error.message)
-      expect(err.data.code).toEqual('credentials_required')
-      socket.close()
-      done()
       })
     })
 
-  it('should emit error with bad token format', (done) => {
+    await t.test("should contains user properties", () => {
-    const socket = io('http://localhost:9000', {
-      auth: { token: 'testing' }
-    })
-    socket.on('connect_error', (err: any) => {
-      expect(err.data.message).toEqual(
-        'Format is Authorization: Bearer [token]'
-      )
-      expect(err.data.code).toEqual('credentials_bad_format')
-      socket.close()
-      done()
-    })
-  })
-
-  it('should emit error with unauthorized handshake', (done) => {
-    const socket = io('http://localhost:9000', {
-      auth: { token: 'Bearer testing' }
-    })
-    socket.on('connect_error', (err: any) => {
-      expect(err.data.message).toEqual(
-        'Unauthorized: Token is missing or invalid Bearer'
-      )
-      expect(err.data.code).toEqual('invalid_token')
-      socket.close()
-      done()
-    })
-  })
-
-  it('should connect the user', (done) => {
-    const socket = io('http://localhost:9000', {
-      auth: { token: `Bearer ${token}` }
-    })
-    socket.on('connect', () => {
-      socket.close()
-      done()
-    })
-  })
-
-  it('should contain user property', (done) => {
       const socketServer = getSocket()
-    socketServer?.on('connection', (client: any) => {
+      socketServer?.on("connection", (client: any) => {
-      expect(client.user.email).toEqual('john@doe.com')
+        assert.strictEqual(client.user.email, basicProfile.email)
+        assert.ok(true)
       })
-    const socket = io('http://localhost:9000', {
+      socket = io(API_URL, {
-      auth: { token: `Bearer ${token}` }
+        auth: { token: `Bearer ${token}` },
       })
-    socket.on('connect', () => {
+      socket.on("connect_error", async (error) => {
-      socket.close()
+        assert.fail(error.message)
-      done()
       })
     })
 
-  it('should emit error when user validation fails', (done) => {
+    await t.test("should emit error when user validation fails", () => {
-    const socket = io('http://localhost:9000', {
+      socket = io(API_URL, {
-      auth: { token: `Bearer ${wrongToken}` }
+        auth: { token: `Bearer ${wrongToken}` },
       })
-    socket.on('connect_error', (err: any) => {
+      socket.on("connect_error", async (error) => {
         try {
-        expect(err.message).toEqual('Check Field validation failed')
+          assert.strictEqual(error.message, "Check Field validation failed")
-      } catch (err) {
+          assert.ok(true)
-        socket.close()
+        } catch {
-        done(err)
+          assert.fail(error.message)
         }
-      socket.close()
+      })
-      done()
+      socket.on("connect", async () => {
+        assert.fail("should not connect")
+      })
     })
   })
 })

src/__test__/fixture/index.ts

@@ -1,76 +1,83 @@
-import express from 'express'
+import jwt from "jsonwebtoken"
-import jwt from 'jsonwebtoken'
+import { Server as SocketIoServer } from "socket.io"
-import { Server as HttpServer } from 'http'
+import type { FastifyInstance } from "fastify"
-import { Server as HttpsServer } from 'https'
+import fastify from "fastify"
-import { Server as SocketIoServer } from 'socket.io'
-import enableDestroy from 'server-destroy'
 
-import { authorize, AuthorizeOptions } from '../../index'
+import type { AuthorizeOptions } from "../../index.js"
+import { authorize } from "../../index.js"
 
-export interface Profile {
+interface FastifyIo {
+  instance: SocketIoServer
+}
+
+declare module "fastify" {
+  export interface FastifyInstance {
+    io: FastifyIo
+  }
+}
+
+export interface BasicProfile {
   email: string
   id: number
+}
+
+export interface Profile extends BasicProfile {
   checkField: boolean
 }
 
-interface Socket {
+export const PORT = 9000
-  io: null | SocketIoServer
+export const API_URL = `http://localhost:${PORT}`
-  init: (httpServer: HttpServer | HttpsServer) => void
+export const basicProfile: BasicProfile = {
+  email: "john@doe.com",
+  id: 123,
 }
 
-const socket: Socket = {
+let application: FastifyInstance | null = null
-  io: null,
-  init (httpServer) {
-    socket.io = new SocketIoServer(httpServer)
-  }
-}
-
-let server: HttpServer | null = null
 
 export const fixtureStart = async (
-  done: any,
+  options: AuthorizeOptions = { secret: "super secret" },
-  options: AuthorizeOptions = { secret: 'super secret' }
 ): Promise<void> => {
-  const profile: Profile = {
+  const profile: Profile = { ...basicProfile, checkField: true }
-    email: 'john@doe.com',
+  let keySecret = ""
-    id: 123,
+  if (typeof options.secret === "string") {
-    checkField: true
-  }
-  let keySecret = ''
-  if (typeof options.secret === 'string') {
     keySecret = options.secret
   } else {
-    keySecret = await options.secret({ header: { alg: 'HS256' }, payload: profile })
+    keySecret = await options.secret({
+      header: { alg: "HS256" },
+      payload: profile,
+    })
   }
-  const app = express()
+  application = fastify()
-  app.use(express.json())
+  application.post("/login", async (_request, reply) => {
-  app.post('/login', (_req, res) => {
     const token = jwt.sign(profile, keySecret, {
-      expiresIn: 60 * 60 * 5
+      expiresIn: 60 * 60 * 5,
     })
-    return res.json({ token })
+    reply.statusCode = 201
+    return { token }
   })
-  app.post('/login-wrong', (_req, res) => {
+  application.post("/login-wrong", async (_request, reply) => {
     profile.checkField = false
     const token = jwt.sign(profile, keySecret, {
-      expiresIn: 60 * 60 * 5
+      expiresIn: 60 * 60 * 5,
     })
-    return res.json({ token })
+    reply.statusCode = 201
+    return { token }
+  })
+  const instance = new SocketIoServer(application.server)
+  instance.use(authorize(options))
+  application.decorate("io", { instance })
+  application.addHook("onClose", (fastify) => {
+    fastify.io.instance.close()
+  })
+  await application.listen({
+    port: PORT,
   })
-  server = app.listen(9000, done)
-  socket.init(server)
-  socket.io?.use(authorize(options))
-  enableDestroy(server)
 }
 
-export const fixtureStop = (callback: Function): void => {
+export const fixtureStop = async (): Promise<void> => {
-  socket.io?.close()
+  await application?.close()
-  try {
-    server?.destroy()
-  } catch {}
-  callback()
 }
 
-export const getSocket = (): SocketIoServer | null => {
+export const getSocket = (): SocketIoServer | undefined => {
-  return socket.io
+  return application?.io.instance
 }

src/__test__/setup.ts

@@ -1 +0,0 @@
-jest.setTimeout(15_000)

src/authorize.ts

@@ -1,16 +1,13 @@
-import jwt, { Algorithm } from 'jsonwebtoken'
+import type { Algorithm } from "jsonwebtoken"
-import { Socket } from 'socket.io'
+import jwt from "jsonwebtoken"
+import type { Socket } from "socket.io"
 
-import { UnauthorizedError } from './UnauthorizedError'
+import { UnauthorizedError } from "./UnauthorizedError.js"
 
-declare module 'socket.io' {
+declare module "socket.io" {
   interface Socket extends ExtendedSocket {}
 }
 
-interface ExtendedError extends Error {
-  data?: any
-}
-
 interface ExtendedSocket {
   encodedToken?: string
   decodedToken?: any
@@ -19,7 +16,7 @@ interface ExtendedSocket {
 
 type SocketIOMiddleware = (
   socket: Socket,
-  next: (err?: ExtendedError) => void
+  next: (error?: UnauthorizedError) => void,
 ) => void
 
 interface CompleteDecodedToken {
@@ -30,7 +27,9 @@ interface CompleteDecodedToken {
   payload: any
 }
 
-type SecretCallback = (decodedToken: CompleteDecodedToken) => Promise<string> | string
+type SecretCallback = (
+  decodedToken: CompleteDecodedToken,
+) => Promise<string> | string
 
 export interface AuthorizeOptions {
   secret: string | SecretCallback
@@ -39,32 +38,32 @@ export interface AuthorizeOptions {
 }
 
 export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
-  const { secret, algorithms = ['HS256'], onAuthentication } = options
+  const { secret, algorithms = ["HS256"], onAuthentication } = options
   return async (socket, next) => {
     let encodedToken: string | null = null
     const { token } = socket.handshake.auth
     if (token != null) {
-      const tokenSplitted = token.split(' ')
+      const tokenSplitted = token.split(" ")
-      if (tokenSplitted.length !== 2 || tokenSplitted[0] !== 'Bearer') {
+      if (tokenSplitted.length !== 2 || tokenSplitted[0] !== "Bearer") {
         return next(
-          new UnauthorizedError('credentials_bad_format', {
+          new UnauthorizedError("credentials_bad_format", {
-            message: 'Format is Authorization: Bearer [token]'
+            message: "Format is Authorization: Bearer [token]",
-          })
+          }),
         )
       }
       encodedToken = tokenSplitted[1]
     }
     if (encodedToken == null) {
       return next(
-        new UnauthorizedError('credentials_required', {
+        new UnauthorizedError("credentials_required", {
-          message: 'no token provided'
+          message: "no token provided",
-        })
+        }),
       )
     }
     socket.encodedToken = encodedToken
     let keySecret: string | null = null
-    let decodedToken: any
+    let decodedToken: any = null
-    if (typeof secret === 'string') {
+    if (typeof secret === "string") {
       keySecret = secret
     } else {
       const completeDecodedToken = jwt.decode(encodedToken, { complete: true })
@@ -74,17 +73,17 @@ export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
       decodedToken = jwt.verify(encodedToken, keySecret, { algorithms })
     } catch {
       return next(
-        new UnauthorizedError('invalid_token', {
+        new UnauthorizedError("invalid_token", {
-          message: 'Unauthorized: Token is missing or invalid Bearer'
+          message: "Unauthorized: Token is missing or invalid Bearer",
-        })
+        }),
       )
     }
     socket.decodedToken = decodedToken
     if (onAuthentication != null) {
       try {
         socket.user = await onAuthentication(decodedToken)
-      } catch (err) {
+      } catch (error: any) {
-        return next(err)
+        return next(error)
       }
     }
     return next()

src/index.ts

@@ -1 +1,2 @@
-export * from './authorize'
+export * from "./authorize.js"
+export * from "./UnauthorizedError.js"

tsconfig.json

@@ -1,13 +1,13 @@
 {
+  "extends": "@tsconfig/strictest/tsconfig.json",
   "compilerOptions": {
     "target": "ESNext",
-    "module": "commonjs",
     "lib": ["ESNext"],
-    "moduleResolution": "node",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
     "outDir": "./build",
     "rootDir": "./src",
-    "strict": true,
+    "emitDeclarationOnly": true,
-    "esModuleInterop": true,
+    "declaration": true
-    "declaration": true,
   }
 }