style: fix linting issue

BREAKING CHANGE: This package is now pure ESM

BREAKING CHANGE: minimum supported Node.js >= 16.0.0

.eslintrc.json

@@ -0,0 +1,15 @@
+{
+  "extends": ["conventions", "prettier"],
+  "plugins": ["prettier", "import", "unicorn"],
+  "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/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

@@ -2,7 +2,7 @@ name: 'Build'
 
 on:
   push:
-    branches: [master, develop]
+    branches: [develop]
   pull_request:
     branches: [master, develop]
 
@@ -10,16 +10,16 @@ jobs:
   build:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: 'actions/checkout@v3.0.0'
 
       - name: 'Use Node.js'
-        uses: 'actions/setup-node@v2.3.0'
+        uses: 'actions/setup-node@v3.1.0'
         with:
-          node-version: '16.x'
+          node-version: 'lts/*'
           cache: 'npm'
 
       - name: 'Install'
         run: 'npm install'
 
-      - name: 'Build Package'
+      - name: 'Build'
         run: 'npm run build'

.github/workflows/lint.yml

@@ -2,7 +2,7 @@ name: 'Lint'
 
 on:
   push:
-    branches: [master, develop]
+    branches: [develop]
   pull_request:
     branches: [master, develop]
 
@@ -10,12 +10,12 @@ jobs:
   lint:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: 'actions/checkout@v3.0.0'
 
       - name: 'Use Node.js'
-        uses: 'actions/setup-node@v2.3.0'
+        uses: 'actions/setup-node@v3.1.0'
         with:
-          node-version: '16.x'
+          node-version: 'lts/*'
           cache: 'npm'
 
       - name: 'Install'
@@ -25,3 +25,4 @@ jobs:
       - run: 'npm run lint:editorconfig'
       - run: 'npm run lint:markdown'
       - run: 'npm run lint:typescript'
+      - run: 'npm run lint:prettier'

.github/workflows/release.yml

@@ -8,12 +8,12 @@ jobs:
   release:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: 'actions/checkout@v3.0.0'
 
       - name: 'Use Node.js'
-        uses: 'actions/setup-node@v2.3.0'
+        uses: 'actions/setup-node@v3.1.0'
         with:
-          node-version: '16.x'
+          node-version: 'lts/*'
           cache: 'npm'
 
       - name: 'Install'

.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: 'Test'
 
 on:
   push:
-    branches: [master, develop]
+    branches: [develop]
   pull_request:
     branches: [master, develop]
 
@@ -10,19 +10,22 @@ jobs:
   test:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v2'
+      - uses: 'actions/checkout@v3.0.0'
 
       - name: 'Use Node.js'
-        uses: 'actions/setup-node@v2.3.0'
+        uses: 'actions/setup-node@v3.1.0'
         with:
-          node-version: '16.x'
+          node-version: 'lts/*'
           cache: 'npm'
 
       - name: 'Install'
         run: 'npm install'
 
+      - name: 'Build'
+        run: 'npm run build'
+
       - name: 'Test'
         run: 'npm run test'
 
       - name: 'Upload Coverage'
-        uses: 'codecov/codecov-action@v2.0.1'
+        uses: 'codecov/codecov-action@v3.0.0'

.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,5 @@
 #!/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

.lintstagedrc.json

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

.nycrc.json

@@ -0,0 +1,5 @@
+{
+  "reporter": ["text", "cobertura"],
+  "src": "./build",
+  "all": true
+}

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "jsxSingleQuote": true,
+  "semi": false,
+  "trailingComma": "none"
+}

.swcrc

@@ -0,0 +1,22 @@
+{
+  "jsc": {
+    "parser": {
+      "syntax": "typescript",
+      "decorators": true,
+      "dynamicImport": true
+    },
+    "transform": {
+      "legacyDecorator": true,
+      "decoratorMetadata": true
+    },
+    "target": "es2022",
+    "loose": true
+  },
+  "module": {
+    "type": "es6",
+    "strict": false,
+    "strictMode": true,
+    "lazy": false,
+    "noInterop": false
+  }
+}

.taprc

@@ -0,0 +1,9 @@
+ts: false
+jsx: false
+flow: false
+check-coverage: false
+coverage: false
+timeout: 10000
+
+files:
+  - 'build/**/*.test.js'

.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,10 @@
+{
+  "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
+  }
+}

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.

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**.
 

README.md

@@ -8,7 +8,6 @@
   <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>
@@ -28,8 +27,14 @@ Compatible with `socket.io >= 3.0.0`.
 
 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
+
 ## 💾 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
 ```
@@ -102,7 +107,7 @@ const io = new Server(9000)
 io.use(
   authorize({
     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
     }
@@ -128,6 +133,7 @@ io.on('connection', async (socket) => {
 
 ```ts
 import { io } from 'socket.io-client'
+import { isUnauthorizedError } from '@thream/socketio-jwt'
 
 // Require Bearer Token
 const socket = io('http://localhost:9000', {
@@ -136,7 +142,7 @@ const socket = io('http://localhost:9000', {
 
 // Handling token expiration
 socket.on('connect_error', (error) => {
-  if (error.data.type === 'UnauthorizedError') {
+  if (isUnauthorizedError(error)) {
     console.log('User token has expired')
   }
 })

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,6 +1,8 @@
 {
   "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",
@@ -9,7 +11,10 @@
     "build"
   ],
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=16.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "keywords": [
     "socket",
@@ -19,32 +24,23 @@
   "author": "Divlo <contact@divlo.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 && tsc",
+    "build:dev": "swc ./src --out-dir ./build --watch",
     "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
-    "lint:markdown": "markdownlint '**/*.md' --dot --ignore node_modules",
+    "lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"",
-    "lint:typescript": "ts-standard",
+    "lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
+    "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
+    "lint:staged": "lint-staged",
+    "test": "c8 tap",
     "release": "semantic-release",
-    "test": "jest",
     "postinstall": "husky install",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable"
@@ -56,27 +52,36 @@
     "jsonwebtoken": "8.5.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "12.1.4",
+    "@commitlint/cli": "16.2.3",
-    "@commitlint/config-conventional": "12.1.4",
+    "@commitlint/config-conventional": "16.2.1",
-    "@types/express": "4.17.13",
+    "@swc/cli": "0.1.57",
-    "@types/jest": "26.0.24",
+    "@swc/core": "1.2.164",
-    "@types/jsonwebtoken": "8.5.4",
+    "@types/jsonwebtoken": "8.5.8",
-    "@types/node": "16.4.1",
+    "@types/node": "17.0.23",
-    "@types/server-destroy": "1.0.1",
+    "@types/tap": "15.0.6",
-    "axios": "0.21.1",
+    "@typescript-eslint/eslint-plugin": "5.18.0",
+    "@typescript-eslint/parser": "5.18.0",
+    "axios": "0.26.1",
+    "c8": "7.11.0",
     "editorconfig-checker": "4.0.2",
-    "express": "4.17.1",
+    "eslint": "8.12.0",
-    "husky": "7.0.1",
+    "eslint-config-conventions": "2.0.0",
-    "jest": "27.0.6",
+    "eslint-config-prettier": "8.5.0",
-    "markdownlint-cli": "0.28.1",
+    "eslint-plugin-import": "2.26.0",
-    "pinst": "2.1.6",
+    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-promise": "6.0.0",
+    "eslint-plugin-unicorn": "42.0.0",
+    "fastify": "3.28.0",
+    "husky": "7.0.4",
+    "lint-staged": "12.3.7",
+    "markdownlint-cli": "0.31.1",
+    "pinst": "3.0.0",
+    "prettier": "2.6.2",
     "rimraf": "3.0.2",
-    "semantic-release": "17.4.4",
+    "semantic-release": "19.0.2",
-    "server-destroy": "1.0.1",
+    "socket.io": "4.4.1",
-    "socket.io": "4.1.3",
+    "socket.io-client": "4.4.1",
-    "socket.io-client": "4.1.3",
+    "tap": "16.0.1",
-    "ts-jest": "27.0.4",
+    "typescript": "4.6.3"
-    "ts-standard": "10.0.0",
-    "typescript": "4.3.5"
   }
 }

src/UnauthorizedError.ts

@@ -1,10 +1,10 @@
 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,
@@ -14,3 +14,7 @@ export class UnauthorizedError extends Error {
     Object.setPrototypeOf(this, UnauthorizedError.prototype)
   }
 }
+
+export const isUnauthorizedError = (error: any): error is UnauthorizedError => {
+  return error.data.type === 'UnauthorizedError'
+}

src/__test__/authorize.test.ts

@@ -1,170 +1,204 @@
+import tap from 'tap'
 import axios from 'axios'
-import { io } from 'socket.io-client'
+import { io, Socket } from 'socket.io-client'
 
-import { fixtureStart, fixtureStop, getSocket, Profile } from './fixture'
+import { isUnauthorizedError } from '../UnauthorizedError.js'
+import {
+  API_URL,
+  fixtureStart,
+  fixtureStop,
+  getSocket,
+  basicProfile,
+  Profile
+} from './fixture/index.js'
 
-describe('authorize - with secret as string in options', () => {
+export const api = axios.create({
-  let token: string = ''
+  baseURL: API_URL,
-
+  headers: {
-  beforeEach((done) => {
+    'Content-Type': 'application/json'
-    fixtureStart(async () => {
+  }
-      const response = await axios.post('http://localhost:9000/login')
-      token = response.data.token
-    })
-      .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'
 }
 
-describe('authorize - with secret as callback in options', () => {
+await tap.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 () => {
-      .then(done)
+      socket?.disconnect()
-      .catch((error) => {
+      await fixtureStop()
-        done(error)
+    })
+
+    await t.test('should emit error with no token provided', (t) => {
+      t.plan(4)
+      socket = io(API_URL)
+      socket.on('connect_error', async (error) => {
+        t.equal(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          t.equal(error.data.message, 'no token provided')
+          t.equal(error.data.code, 'credentials_required')
+        }
+        t.pass()
+      })
+      socket.on('connect', async () => {
+        t.fail()
       })
     })
 
-  afterEach((done) => {
+    await t.test('should emit error with bad token format', (t) => {
-    fixtureStop(done)
+      t.plan(4)
-  })
+      socket = io(API_URL, {
-
-  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) => {
+      socket.on('connect_error', async (error) => {
-      expect(err.data.message).toEqual(
+        t.equal(isUnauthorizedError(error), true)
-        'Format is Authorization: Bearer [token]'
+        if (isUnauthorizedError(error)) {
-      )
+          t.equal(error.data.message, 'Format is Authorization: Bearer [token]')
-      expect(err.data.code).toEqual('credentials_bad_format')
+          t.equal(error.data.code, 'credentials_bad_format')
-      socket.close()
+        }
-      done()
+        t.pass()
+      })
+      socket.on('connect', async () => {
+        t.fail()
       })
     })
 
-  it('should emit error with unauthorized handshake', (done) => {
+    await t.test('should emit error with unauthorized handshake', (t) => {
-    const socket = io('http://localhost:9000', {
+      t.plan(4)
+      socket = io(API_URL, {
         auth: { token: 'Bearer testing' }
       })
-    socket.on('connect_error', (err: any) => {
+      socket.on('connect_error', async (error) => {
-      expect(err.data.message).toEqual(
+        t.equal(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          t.equal(
+            error.data.message,
             'Unauthorized: Token is missing or invalid Bearer'
           )
-      expect(err.data.code).toEqual('invalid_token')
+          t.equal(error.data.code, 'invalid_token')
-      socket.close()
+        }
-      done()
+        t.pass()
+      })
+      socket.on('connect', async () => {
+        t.fail()
       })
     })
 
-  it('should connect the user', (done) => {
+    await t.test('should connect the user', (t) => {
-    const socket = io('http://localhost:9000', {
+      t.plan(1)
+      socket = io(API_URL, {
         auth: { token: `Bearer ${token}` }
       })
-    socket.on('connect', () => {
+      socket.on('connect', async () => {
-      socket.close()
+        t.pass()
-      done()
+      })
+      socket.on('connect_error', async (error) => {
+        t.fail(error.message)
       })
-    socket.on('connect_error', (err: any) => {
-      done(err)
     })
   })
-})
 
-describe('authorize - with onAuthentication callback in options', () => {
+  await t.test('with secret as callback in options', async (t) => {
-  let token: string = ''
+    let token = ''
-  let wrongToken: string = ''
+    let socket: Socket | null = null
 
-  beforeEach((done) => {
+    t.beforeEach(async () => {
-    fixtureStart(
+      await fixtureStart({ secret: secretCallback })
-      async () => {
+      const response = await api.post('/login', {})
-        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', (t) => {
+      t.plan(4)
+      socket = io(API_URL)
+      socket.on('connect_error', async (error) => {
+        t.equal(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          t.equal(error.data.message, 'no token provided')
+          t.equal(error.data.code, 'credentials_required')
+        }
+        t.pass()
+      })
+      socket.on('connect', async () => {
+        t.fail()
+      })
+    })
+
+    await t.test('should emit error with bad token format', (t) => {
+      t.plan(4)
+      socket = io(API_URL, {
+        auth: { token: 'testing' }
+      })
+      socket.on('connect_error', async (error) => {
+        t.equal(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          t.equal(error.data.message, 'Format is Authorization: Bearer [token]')
+          t.equal(error.data.code, 'credentials_bad_format')
+        }
+        t.pass()
+      })
+      socket.on('connect', async () => {
+        t.fail()
+      })
+    })
+
+    await t.test('should emit error with unauthorized handshake', (t) => {
+      t.plan(4)
+      socket = io(API_URL, {
+        auth: { token: 'Bearer testing' }
+      })
+      socket.on('connect_error', async (error) => {
+        t.equal(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          t.equal(
+            error.data.message,
+            'Unauthorized: Token is missing or invalid Bearer'
           )
-        wrongToken = responseWrong.data.token
+          t.equal(error.data.code, 'invalid_token')
-      },
+        }
-      {
+        t.pass()
+      })
+      socket.on('connect', async () => {
+        t.fail()
+      })
+    })
+
+    await t.test('should connect the user', (t) => {
+      t.plan(1)
+      socket = io(API_URL, {
+        auth: { token: `Bearer ${token}` }
+      })
+      socket.on('connect', async () => {
+        t.pass()
+      })
+      socket.on('connect_error', async (error) => {
+        t.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) {
@@ -174,93 +208,117 @@ describe('authorize - with onAuthentication callback in options', () => {
             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', (t) => {
+      t.plan(4)
+      socket = io(API_URL)
+      socket.on('connect_error', async (error) => {
+        t.equal(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          t.equal(error.data.message, 'no token provided')
+          t.equal(error.data.code, 'credentials_required')
         }
-    )
+        t.pass()
-      .then(done)
+      })
-      .catch((error) => {
+      socket.on('connect', async () => {
-        done(error)
+        t.fail()
       })
     })
 
-  afterEach((done) => {
+    await t.test('should emit error with bad token format', (t) => {
-    fixtureStop(done)
+      t.plan(4)
-  })
+      socket = io(API_URL, {
-
-  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) => {
+      socket.on('connect_error', async (error) => {
-      expect(err.data.message).toEqual(
+        t.equal(isUnauthorizedError(error), true)
-        'Format is Authorization: Bearer [token]'
+        if (isUnauthorizedError(error)) {
-      )
+          t.equal(error.data.message, 'Format is Authorization: Bearer [token]')
-      expect(err.data.code).toEqual('credentials_bad_format')
+          t.equal(error.data.code, 'credentials_bad_format')
-      socket.close()
+        }
-      done()
+        t.pass()
+      })
+      socket.on('connect', async () => {
+        t.fail()
       })
     })
 
-  it('should emit error with unauthorized handshake', (done) => {
+    await t.test('should emit error with unauthorized handshake', (t) => {
-    const socket = io('http://localhost:9000', {
+      t.plan(4)
+      socket = io(API_URL, {
         auth: { token: 'Bearer testing' }
       })
-    socket.on('connect_error', (err: any) => {
+      socket.on('connect_error', async (error) => {
-      expect(err.data.message).toEqual(
+        t.equal(isUnauthorizedError(error), true)
+        if (isUnauthorizedError(error)) {
+          t.equal(
+            error.data.message,
             'Unauthorized: Token is missing or invalid Bearer'
           )
-      expect(err.data.code).toEqual('invalid_token')
+          t.equal(error.data.code, 'invalid_token')
-      socket.close()
+        }
-      done()
+        t.pass()
+      })
+      socket.on('connect', async () => {
+        t.fail()
       })
     })
 
-  it('should connect the user', (done) => {
+    await t.test('should connect the user', (t) => {
-    const socket = io('http://localhost:9000', {
+      t.plan(1)
+      socket = io(API_URL, {
         auth: { token: `Bearer ${token}` }
       })
-    socket.on('connect', () => {
+      socket.on('connect', async () => {
-      socket.close()
+        t.pass()
-      done()
+      })
+      socket.on('connect_error', async (error) => {
+        t.fail(error.message)
       })
     })
 
-  it('should contain user property', (done) => {
+    await t.test('should contains user properties', (t) => {
+      t.plan(2)
       const socketServer = getSocket()
       socketServer?.on('connection', (client: any) => {
-      expect(client.user.email).toEqual('john@doe.com')
+        t.equal(client.user.email, basicProfile.email)
+        t.pass()
       })
-    const socket = io('http://localhost:9000', {
+      socket = io(API_URL, {
         auth: { token: `Bearer ${token}` }
       })
-    socket.on('connect', () => {
+      socket.on('connect_error', async (error) => {
-      socket.close()
+        t.fail(error.message)
-      done()
       })
     })
 
-  it('should emit error when user validation fails', (done) => {
+    await t.test('should emit error when user validation fails', (t) => {
-    const socket = io('http://localhost:9000', {
+      t.plan(2)
+      socket = io(API_URL, {
         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')
+          t.equal(error.message, 'Check Field validation failed')
-      } catch (err) {
+          t.pass()
-        socket.close()
+        } catch {
-        done(err)
+          t.fail()
         }
-      socket.close()
+      })
-      done()
+      socket.on('connect', async () => {
+        t.fail()
+      })
     })
   })
 })

src/__test__/fixture/index.ts

@@ -1,76 +1,79 @@
-import express from 'express'
 import jwt from 'jsonwebtoken'
-import { Server as HttpServer } from 'http'
-import { Server as HttpsServer } from 'https'
 import { Server as SocketIoServer } from 'socket.io'
-import enableDestroy from 'server-destroy'
+import fastify, { FastifyInstance } from 'fastify'
 
-import { authorize, AuthorizeOptions } from '../../index'
+import { authorize, AuthorizeOptions } 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' }
 ): Promise<void> => {
-  const profile: Profile = {
+  const profile: Profile = { ...basicProfile, checkField: true }
-    email: 'john@doe.com',
-    id: 123,
-    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
     })
-    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
     })
-    return res.json({ token })
+    reply.statusCode = 201
+    return { token }
   })
-  server = app.listen(9000, done)
+  const instance = new SocketIoServer(application.server)
-  socket.init(server)
+  instance.use(authorize(options))
-  socket.io?.use(authorize(options))
+  application.decorate('io', { instance })
-  enableDestroy(server)
+  application.addHook('onClose', (fastify) => {
+    fastify.io.instance.close()
+  })
+  await application.listen(PORT)
 }
 
-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,12 @@
 import jwt, { Algorithm } from 'jsonwebtoken'
 import { Socket } from 'socket.io'
 
-import { UnauthorizedError } from './UnauthorizedError'
+import { UnauthorizedError } from './UnauthorizedError.js'
 
 declare module 'socket.io' {
   interface Socket extends ExtendedSocket {}
 }
 
-interface ExtendedError extends Error {
-  data?: any
-}
-
 interface ExtendedSocket {
   encodedToken?: string
   decodedToken?: any
@@ -19,7 +15,7 @@ interface ExtendedSocket {
 
 type SocketIOMiddleware = (
   socket: Socket,
-  next: (err?: ExtendedError) => void
+  next: (error?: UnauthorizedError) => void
 ) => void
 
 interface CompleteDecodedToken {
@@ -30,7 +26,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
@@ -83,8 +81,8 @@ export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
     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,15 @@
 {
   "compilerOptions": {
     "target": "ESNext",
-    "module": "commonjs",
+    "module": "ESNext",
     "lib": ["ESNext"],
     "moduleResolution": "node",
     "outDir": "./build",
     "rootDir": "./src",
-    "strict": true,
+    "emitDeclarationOnly": true,
-    "esModuleInterop": true,
     "declaration": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true
   }
 }