Compare commits

...

140 Commits

Author SHA1 Message Date
cfcb8a4be2
fix: archive repository
This project is not anymore maintained.
2024-11-11 14:55:04 +01:00
5f2742be0b
chore: better Prettier config for easier reviews 2023-10-23 23:44:50 +02:00
2d84d11034
fix: update jsonwebtoken from v9.0.1 to v9.0.2 2023-09-18 21:45:05 +02:00
4ba9a452ea
docs: improve Prerequisites section 2023-08-06 11:45:16 +02:00
6a28554b00
fix: update jsonwebtoken from v9.0.0 to v9.0.1 2023-07-22 12:20:18 +02:00
50c236ca4d
refactor: usage of node:test instead of tap 2023-07-22 12:18:28 +02:00
b708d66586
chore: sync package-lock.json 2023-07-02 18:14:09 +02:00
d1145e5f63
perf: ignore test files in published package (reduce package size) 2023-07-02 18:12:07 +02:00
487965b9aa
chore: clean up 2023-07-02 18:10:38 +02:00
108ae8f6fc
fix: update author - Théo LUDWIG 2023-07-02 18:08:35 +02:00
7d0df02299
build(deps): update latest 2023-07-02 18:05:47 +02:00
Divlo
26bbc075cf
feat: add npm package provenance
Ref: https://github.blog/2023-04-19-introducing-npm-package-provenance/
2023-05-13 19:34:01 +02:00
Divlo
41d9424940
build(deps): update latest 2023-05-13 19:25:45 +02:00
Divlo
41a0f1839f
fix: safer (and correct) isUnauthorizedError 2023-04-02 23:32:28 +02:00
Divlo
71e0d82655
fix: safer isUnauthorizedError type guard 2023-04-02 23:04:41 +02:00
Divlo
03e8d51f9a
fix: bump jsonwebtoken to v9.0.0
fixes #342

It introduces several security fixes to follow best practices.
2023-01-10 20:57:23 +01:00
Divlo
bf234bd7b8
docs: client side usage, specify build in import 2022-09-09 12:10:12 +02:00
Divlo
ff6a84a8e1
fix: publish updated README 2022-09-09 11:41:42 +02:00
Divlo
c7c152a554
build(deps): update latest 2022-09-09 11:39:27 +02:00
dependabot[bot]
7977c42c20
build(deps): bump npm from 8.10.0 to 8.12.0 (#338) 2022-07-25 12:52:11 +02:00
dependabot[bot]
05b9eea638
build(deps): bump semver-regex from 3.1.3 to 3.1.4 (#339) 2022-07-25 12:51:59 +02:00
dependabot[bot]
e14b456d9a
build(deps-dev): bump semantic-release from 19.0.2 to 19.0.3 (#340) 2022-07-25 12:51:41 +02:00
Divlo
f85595224f
build(deps): update latest 2022-05-12 21:26:33 +02:00
Divlo
1247a9b5f0
chore: remove codecov 2022-05-12 21:24:15 +02:00
Divlo
9a942c52c5
style: fix linting issue 2022-04-07 10:14:52 +02:00
Divlo
dbb363747d
feat: usage of ESM modules imports (instead of CommonJS)
BREAKING CHANGE: This package is now pure ESM

BREAKING CHANGE: minimum supported Node.js >= 16.0.0
2022-04-07 10:11:48 +02:00
Divlo
559ad8bd6d
ci: avoid duplicate runs 2022-03-01 09:02:21 +01:00
Divlo
e68ed3c432
fix: emit types declaration 2022-02-19 10:36:34 +01:00
Divlo
098475d64c
feat: add isUnauthorizedError type guard
fixes #328
2022-02-18 17:20:59 +01:00
dependabot[bot]
056c7b4807
build(deps-dev): bump @commitlint/config-conventional to 16.2.1 (#331) 2022-02-15 10:49:26 +01:00
dependabot[bot]
25c74045a9
build(deps): bump engine.io from 6.1.0 to 6.1.2 (#334) 2022-02-15 10:49:08 +01:00
dependabot[bot]
f68daca38b
build(deps-dev): bump @commitlint/cli from 16.1.0 to 16.2.1 (#329) 2022-02-15 10:48:02 +01:00
dependabot[bot]
f78f58cd4b
build(deps-dev): bump axios from 0.25.0 to 0.26.0 (#330) 2022-02-15 10:47:36 +01:00
dependabot[bot]
7eb3634286
build(deps-dev): bump @types/node from 17.0.16 to 17.0.18 (#333) 2022-02-15 10:47:22 +01:00
dependabot[bot]
853aa301de
build(deps-dev): bump markdownlint-cli from 0.31.0 to 0.31.1 (#326) 2022-02-10 11:23:08 +01:00
dependabot[bot]
1d853e2457
build(deps-dev): bump jest from 27.5.0 to 27.5.1 (#325) 2022-02-09 17:45:56 +01:00
dependabot[bot]
585e488471
build(deps-dev): bump @types/node from 17.0.15 to 17.0.16 (#324) 2022-02-08 12:41:14 +01:00
dependabot[bot]
1088803ee2
build(deps-dev): bump jest from 27.4.7 to 27.5.0 (#322) 2022-02-07 15:39:46 +01:00
dependabot[bot]
280d9eb485
build(deps-dev): bump @types/node from 17.0.14 to 17.0.15 (#321) 2022-02-07 15:37:48 +01:00
dependabot[bot]
033a8be43e
build(deps-dev): bump markdownlint-cli from 0.30.0 to 0.31.0 (#323) 2022-02-07 15:37:27 +01:00
dependabot[bot]
8d2ff1b7c3
build(deps-dev): bump @types/node from 17.0.13 to 17.0.14 (#320) 2022-02-04 17:15:34 +01:00
dependabot[bot]
91c9820846
build(deps): bump node-fetch from 2.6.6 to 2.6.7 (#319) 2022-01-31 10:41:23 +01:00
dependabot[bot]
8b94866469
build(deps-dev): bump @types/node from 17.0.10 to 17.0.13 (#318) 2022-01-29 16:08:52 +01:00
dependabot[bot]
911a5f20db
build(deps-dev): bump typescript from 4.5.4 to 4.5.5 (#315) 2022-01-22 13:51:45 +01:00
dependabot[bot]
56d3420c71
build(deps-dev): bump @types/node from 17.0.8 to 17.0.10 (#311) 2022-01-22 13:49:39 +01:00
dependabot[bot]
025f8d9c3d
build(deps-dev): bump axios from 0.24.0 to 0.25.0 (#310) 2022-01-22 13:44:26 +01:00
dependabot[bot]
844cd7d138
build(deps-dev): bump @types/jsonwebtoken from 8.5.7 to 8.5.8 (#308) 2022-01-22 13:44:15 +01:00
dependabot[bot]
6d9d36dea5
build(deps-dev): bump semantic-release from 18.0.1 to 19.0.2 (#312) 2022-01-22 13:44:04 +01:00
dependabot[bot]
54bcaab4ea
build(deps-dev): bump @commitlint/cli from 16.0.2 to 16.1.0 (#314) 2022-01-22 13:43:50 +01:00
dependabot[bot]
87a2542abc
build(deps-dev): bump ts-jest from 27.1.2 to 27.1.3 (#307) 2022-01-17 18:48:01 +01:00
dependabot[bot]
c944d36e06
build(deps-dev): bump @types/jsonwebtoken from 8.5.6 to 8.5.7 (#306) 2022-01-15 00:10:34 +01:00
dependabot[bot]
c6d6ef997e
build(deps-dev): bump @commitlint/cli from 16.0.1 to 16.0.2 (#305) 2022-01-15 00:10:24 +01:00
dependabot[bot]
5f85941f43
build(deps-dev): bump socket.io-client from 4.4.0 to 4.4.1 (#303) 2022-01-07 15:45:39 +01:00
dependabot[bot]
d5447a5f29
build(deps-dev): bump jest from 27.4.5 to 27.4.7 (#302) 2022-01-07 15:45:27 +01:00
dependabot[bot]
1f50d858e5
build(deps-dev): bump @types/node from 17.0.5 to 17.0.8 (#301) 2022-01-07 15:45:05 +01:00
dependabot[bot]
5949d0e4e0
build(deps-dev): bump socket.io from 4.4.0 to 4.4.1 (#304) 2022-01-07 15:44:47 +01:00
dependabot[bot]
4ac3dfd37f
build(deps-dev): bump @types/jest from 27.0.3 to 27.4.0 (#297) 2022-01-01 02:44:53 +01:00
dependabot[bot]
8c6bd1fe7d
build(deps): bump actions/setup-node from 2.5.0 to 2.5.1 (#296) 2021-12-29 11:08:40 +01:00
Divlo
8165c13a64
chore: recreate package-lock.json 2021-12-28 15:11:05 +01:00
dependabot[bot]
54f11e3736
build(deps-dev): bump @commitlint/cli from 15.0.0 to 16.0.1 (#295) 2021-12-28 15:07:17 +01:00
dependabot[bot]
f715eb2356
build(deps-dev): bump typescript from 4.5.2 to 4.5.4 (#284) 2021-12-28 15:06:21 +01:00
dependabot[bot]
ee97a6decb
build(deps-dev): bump @commitlint/config-conventional 16.0.0 (#294) 2021-12-28 15:06:05 +01:00
dependabot[bot]
c92e84b81e
build(deps-dev): bump jest from 27.4.3 to 27.4.5 (#283) 2021-12-28 15:05:48 +01:00
dependabot[bot]
a470151958
build(deps-dev): bump express from 4.17.1 to 4.17.2 (#287) 2021-12-28 15:05:27 +01:00
dependabot[bot]
7b8dc0c03f
build(deps-dev): bump ts-jest from 27.1.0 to 27.1.2 (#288) 2021-12-28 15:05:10 +01:00
dependabot[bot]
112be97015
build(deps-dev): bump @types/node from 16.11.11 to 17.0.5 (#293) 2021-12-28 15:04:58 +01:00
dependabot[bot]
6f2f301562
build(deps-dev): bump ts-jest from 27.0.7 to 27.1.0 (#278) 2021-12-07 20:43:37 +01:00
dependabot[bot]
a78c770a52
build(deps-dev): bump jest from 27.3.1 to 27.4.3 (#277) 2021-12-04 18:04:58 +01:00
dependabot[bot]
24489d5e55
build(deps): bump actions/setup-node from 2.4.1 to 2.5.0 (#273) 2021-11-30 14:52:49 +01:00
dependabot[bot]
64ef87b2a2
build(deps-dev): bump semantic-release from 18.0.0 to 18.0.1 (#272) 2021-11-30 14:52:36 +01:00
dependabot[bot]
1b9c39bd82
build(deps-dev): bump @types/node from 16.11.9 to 16.11.11 (#274) 2021-11-30 14:52:23 +01:00
dependabot[bot]
df4522c0c7
build(deps-dev): bump markdownlint-cli from 0.29.0 to 0.30.0 (#270) 2021-11-30 14:52:11 +01:00
dependabot[bot]
1b079565bc
build(deps-dev): bump @types/node from 16.11.8 to 16.11.9 (#269) 2021-11-19 21:53:46 +01:00
dependabot[bot]
bcced4001a
build(deps-dev): bump socket.io-client from 4.3.2 to 4.4.0 (#266) 2021-11-19 21:53:35 +01:00
dependabot[bot]
b0ab7a1ef3
build(deps-dev): bump @types/jest from 27.0.2 to 27.0.3 (#265) 2021-11-19 14:37:37 +01:00
dependabot[bot]
b24597ddc7
build(deps-dev): bump @types/node from 16.11.7 to 16.11.8 (#267) 2021-11-19 14:37:21 +01:00
dependabot[bot]
4035af075f
build(deps-dev): bump socket.io from 4.3.2 to 4.4.0 (#268) 2021-11-19 14:37:12 +01:00
dependabot[bot]
0cee31c8aa
build(deps-dev): bump @commitlint/cli from 14.1.0 to 15.0.0 (#261) 2021-11-18 19:28:47 +01:00
dependabot[bot]
3d52581092
build(deps-dev): bump @types/jsonwebtoken from 8.5.5 to 8.5.6 (#260) 2021-11-18 19:28:37 +01:00
dependabot[bot]
74de828af7
build(deps-dev): bump ts-standard from 10.0.0 to 11.0.0 (#263) 2021-11-18 19:28:27 +01:00
dependabot[bot]
9a525578e1
build(deps-dev): bump @commitlint/config-conventional to 15.0.0 (#262) 2021-11-18 18:22:40 +01:00
dependabot[bot]
b537a4c594
build(deps-dev): bump typescript from 4.4.4 to 4.5.2 (#264) 2021-11-18 18:22:16 +01:00
dependabot[bot]
c2229809f4
build(deps-dev): bump @types/node from 16.11.6 to 16.11.7 (#258) 2021-11-09 15:16:44 +01:00
dependabot[bot]
8042db1eb3
build(deps-dev): bump socket.io from 4.3.1 to 4.3.2 (#259) 2021-11-09 15:16:25 +01:00
dependabot[bot]
af3ae33e24
build(deps-dev): bump @commitlint/config-conventional to 14.1.0 (#256) 2021-11-05 23:31:15 +01:00
dependabot[bot]
21dd8971ad
build(deps-dev): bump @commitlint/cli from 13.2.1 to 14.1.0 (#257) 2021-11-05 23:28:18 +01:00
dependabot[bot]
020220210b
build(deps-dev): bump @types/node from 16.11.2 to 16.11.6 (#255) 2021-10-28 11:09:16 +02:00
dependabot[bot]
8295acaba3
build(deps-dev): bump axios from 0.21.4 to 0.24.0 (#254) 2021-10-28 11:09:00 +02:00
dependabot[bot]
cfc166cd48
build(deps-dev): bump @types/node from 16.11.1 to 16.11.2 (#252) 2021-10-23 12:48:49 +02:00
dependabot[bot]
c0b7d2128f
build(deps-dev): bump jest from 27.2.5 to 27.3.1 (#250) 2021-10-21 10:37:03 +02:00
dependabot[bot]
f594c17097
build(deps-dev): bump husky from 7.0.2 to 7.0.4 (#251) 2021-10-21 10:33:22 +02:00
dependabot[bot]
577aadb022
build(deps-dev): bump socket.io-client from 4.3.0 to 4.3.2 (#245) 2021-10-18 16:00:46 +02:00
dependabot[bot]
6b79e86277
build(deps-dev): bump ts-jest from 27.0.5 to 27.0.7 (#246) 2021-10-18 16:00:08 +02:00
dependabot[bot]
257f967ba6
build(deps-dev): bump socket.io from 4.3.0 to 4.3.1 (#247) 2021-10-18 15:59:55 +02:00
dependabot[bot]
5c3d12a201
build(deps-dev): bump @types/node from 16.11.0 to 16.11.1 (#248) 2021-10-18 15:59:40 +02:00
dependabot[bot]
bea0548d7d
build(deps-dev): bump socket.io from 4.2.0 to 4.3.0 (#242) 2021-10-16 00:05:14 +02:00
dependabot[bot]
30bbbd8f59
build(deps-dev): bump socket.io-client from 4.2.0 to 4.3.0 (#241) 2021-10-16 00:02:36 +02:00
dependabot[bot]
ece3c53fbf
build(deps-dev): bump @types/node from 16.10.3 to 16.11.0 (#243) 2021-10-16 00:02:26 +02:00
dependabot[bot]
094b1cd257
build(deps-dev): bump typescript from 4.4.3 to 4.4.4 (#239) 2021-10-16 00:02:16 +02:00
dependabot[bot]
520df540b5
build(deps-dev): bump @commitlint/cli from 13.2.0 to 13.2.1 (#235) 2021-10-11 19:31:09 +02:00
dependabot[bot]
162ca4401d
build(deps-dev): bump jest from 27.2.4 to 27.2.5 (#236) 2021-10-11 19:30:59 +02:00
dependabot[bot]
f88772710d
build(deps-dev): bump markdownlint-cli from 0.28.1 to 0.29.0 (#233) 2021-10-07 07:36:23 +02:00
dependabot[bot]
2f696bca36
build(deps-dev): bump @types/node from 16.10.2 to 16.10.3 (#234) 2021-10-07 07:36:09 +02:00
dependabot[bot]
336cc8d6a6
build(deps-dev): bump jest from 27.2.2 to 27.2.4 (#230) 2021-09-30 21:12:06 +02:00
dependabot[bot]
b48136818e
build(deps-dev): bump @types/node from 16.10.1 to 16.10.2 (#229) 2021-09-30 21:11:55 +02:00
dependabot[bot]
4de72a1b3d
build(deps-dev): bump @commitlint/config-conventional (#226) 2021-09-28 17:03:30 +02:00
dependabot[bot]
d6785b99d2
build(deps): bump actions/setup-node from 2.4.0 to 2.4.1 (#225) 2021-09-28 17:03:03 +02:00
dependabot[bot]
8b1fcf51fc
build(deps-dev): bump @commitlint/cli from 13.1.0 to 13.2.0 (#227) 2021-09-28 17:02:39 +02:00
dependabot[bot]
e9e69ea210
build(deps-dev): bump @types/node from 16.9.6 to 16.10.1 (#223) 2021-09-27 19:38:54 +02:00
dependabot[bot]
6996f3aef1
build(deps-dev): bump jest from 27.2.1 to 27.2.2 (#224) 2021-09-27 19:38:44 +02:00
dependabot[bot]
2769000be6
build(deps-dev): bump @types/node from 16.9.4 to 16.9.6 (#221) 2021-09-23 11:04:49 +02:00
dependabot[bot]
b87cab898f
build(deps-dev): bump @types/jest from 27.0.1 to 27.0.2 (#222) 2021-09-23 11:04:37 +02:00
dependabot[bot]
3b644a4682
build(deps): bump codecov/codecov-action from 2.0.3 to 2.1.0 (#215) 2021-09-21 16:47:05 +02:00
dependabot[bot]
33c6027c01
build(deps-dev): bump @types/node from 16.7.10 to 16.9.4 (#218) 2021-09-21 16:46:50 +02:00
dependabot[bot]
a747280e1d
build(deps-dev): bump typescript from 4.4.2 to 4.4.3 (#214) 2021-09-21 16:45:29 +02:00
dependabot[bot]
44e60d10b0
build(deps-dev): bump semantic-release from 17.4.7 to 18.0.0 (#219) 2021-09-21 16:45:12 +02:00
dependabot[bot]
927d5dc5c1
build(deps-dev): bump jest from 27.1.0 to 27.2.1 (#220) 2021-09-21 16:44:59 +02:00
dependabot[bot]
22a35720ff
build(deps-dev): bump axios from 0.21.1 to 0.21.4 (#209) 2021-09-21 16:44:45 +02:00
dependabot[bot]
c461a15566
build(deps-dev): bump socket.io from 4.1.3 to 4.2.0 (#203) 2021-09-01 15:22:08 +02:00
dependabot[bot]
74cddbce37
build(deps-dev): bump socket.io-client from 4.1.3 to 4.2.0 (#204) 2021-09-01 15:21:05 +02:00
dependabot[bot]
075d67b7aa
build(deps-dev): bump @types/node from 16.7.3 to 16.7.10 (#206) 2021-09-01 15:20:51 +02:00
Divlo
2e2ad556d8
docs: remove CHANGELOG.md as we're now using semantic-release 2021-08-27 17:21:18 +02:00
dependabot[bot]
596d6a82c9
build(deps-dev): bump typescript from 4.3.5 to 4.4.2 (#201)
Co-authored-by: Divlo <contact@divlo.fr>
2021-08-27 17:18:31 +02:00
dependabot[bot]
5a7d281798
build(deps): bump codecov/codecov-action from 2.0.2 to 2.0.3 (#197) 2021-08-27 13:06:27 +02:00
dependabot[bot]
6fb3dfef40
build(deps-dev): bump husky from 7.0.1 to 7.0.2 (#198) 2021-08-27 13:06:11 +02:00
dependabot[bot]
37824f15e0
build(deps-dev): bump semantic-release from 17.4.6 to 17.4.7 (#199) 2021-08-27 13:05:58 +02:00
dependabot[bot]
f2f064e03a
build(deps-dev): bump @types/node from 16.7.1 to 16.7.2 (#200) 2021-08-27 13:05:46 +02:00
dependabot[bot]
1ea767e551
build(deps-dev): bump semantic-release from 17.4.5 to 17.4.6 (#196) 2021-08-24 11:56:45 +02:00
dependabot[bot]
09c4fe89be
build(deps-dev): bump @types/node from 16.6.1 to 16.7.1 (#195) 2021-08-23 12:04:19 +02:00
dependabot[bot]
986f7b8cdb
build(deps-dev): bump @types/jsonwebtoken from 8.5.4 to 8.5.5 (#194) 2021-08-20 21:06:24 +02:00
dependabot[bot]
6fd7dc60d7
build(deps-dev): bump semantic-release from 17.4.4 to 17.4.5 (#192) 2021-08-18 14:01:25 +02:00
dependabot[bot]
4408e6e18c
build(deps-dev): bump ts-jest from 27.0.4 to 27.0.5 (#191) 2021-08-18 14:01:13 +02:00
dependabot[bot]
fdc7ee7f06
build(deps-dev): bump @types/node from 16.6.0 to 16.6.1 (#189) 2021-08-16 17:08:16 +02:00
dependabot[bot]
9d5981f403
build(deps-dev): bump @types/jest from 27.0.0 to 27.0.1 (#190) 2021-08-16 17:08:05 +02:00
dependabot[bot]
1409c25824
build(deps-dev): bump @commitlint/config-conventional (#174) 2021-08-12 11:17:28 +02:00
dependabot[bot]
c82aa67e4e
build(deps): bump actions/setup-node from 2.3.0 to 2.4.0 (#184) 2021-08-12 11:16:03 +02:00
dependabot[bot]
2dddbe3d94
build(deps): bump codecov/codecov-action from 2.0.1 to 2.0.2 (#173) 2021-08-12 11:15:51 +02:00
dependabot[bot]
6d02644d60
build(deps-dev): bump @commitlint/cli from 12.1.4 to 13.1.0 (#175) 2021-08-12 11:15:31 +02:00
dependabot[bot]
3908f1e6c4
build(deps-dev): bump @types/jest from 26.0.24 to 27.0.0 (#187) 2021-08-12 11:07:00 +02:00
dependabot[bot]
5cee6e17cd
build(deps-dev): bump @types/node from 16.4.1 to 16.6.0 (#188) 2021-08-12 11:06:47 +02:00
38 changed files with 8962 additions and 19443 deletions

16
.eslintrc.json Normal file
View File

@ -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"
}
}

1
.gitattributes vendored Normal file
View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -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

View File

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

View File

@ -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'
uses: 'actions/setup-node@v2.3.0'
- name: "Setup Node.js"
uses: "actions/setup-node@v3.8.1"
with:
node-version: '16.x'
cache: 'npm'
node-version: "20.x"
cache: "npm"
- name: 'Install'
run: 'npm install'
- name: "Install dependencies"
run: "npm clean-install"
- name: 'Build Package'
run: 'npm run build'
- name: "Build"
run: "npm run build"
- run: "npm run build:typescript"

View File

@ -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'
uses: 'actions/setup-node@v2.3.0'
- name: "Setup Node.js"
uses: "actions/setup-node@v3.8.1"
with:
node-version: '16.x'
cache: 'npm'
node-version: "20.x"
cache: "npm"
- name: 'Install'
run: 'npm install'
- name: "Install dependencies"
run: "npm clean-install"
- run: 'npm run lint:commit -- --to "${{ github.sha }}"'
- run: 'npm run lint:editorconfig'
- run: 'npm run lint:markdown'
- run: 'npm run lint:typescript'
- run: "npm run lint:editorconfig"
- run: "npm run lint:markdown"
- run: "npm run lint:eslint"
- run: "npm run lint:prettier"

View File

@ -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'
uses: 'actions/setup-node@v2.3.0'
- name: "Setup Node.js"
uses: "actions/setup-node@v3.8.1"
with:
node-version: '16.x'
cache: 'npm'
node-version: "20.x"
cache: "npm"
- name: 'Install'
run: 'npm install'
- name: "Install dependencies"
run: "npm clean-install"
- name: 'Build Package'
run: 'npm run build'
- name: "Build Package"
run: "npm run build"
- name: 'Release'
run: 'npm run release'
- run: "npm run build:typescript"
- 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 }}

View File

@ -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'
uses: 'actions/setup-node@v2.3.0'
- name: "Setup Node.js"
uses: "actions/setup-node@v3.8.1"
with:
node-version: '16.x'
cache: 'npm'
node-version: "20.x"
cache: "npm"
- name: 'Install'
run: 'npm install'
- name: "Install dependencies"
run: "npm clean-install"
- name: 'Test'
run: 'npm run test'
- name: "Build"
run: "npm run build"
- name: 'Upload Coverage'
uses: 'codecov/codecov-action@v2.0.1'
- name: "Test"
run: "npm run test"

21
.gitignore vendored
View File

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

View File

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

6
.lintstagedrc.json Normal file
View File

@ -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"]
}

11
.markdownlint-cli2.jsonc Normal file
View File

@ -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"]
}

View File

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

1
.npmrc
View File

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

3
.prettierrc.json Normal file
View File

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

13
.swcrc Normal file
View File

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

8
.vscode/extensions.json vendored Normal file
View File

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

11
.vscode/settings.json vendored Normal file
View File

@ -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" }
}

View File

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

View File

@ -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

View File

@ -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.
### 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.
The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.

View File

@ -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

View File

@ -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 { authorize } from '@thream/socketio-jwt'
import { Server } from "socket.io"
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 { Server } from 'socket.io'
import { authorize } from '@thream/socketio-jwt'
import jwksClient from "jwks-rsa"
import { Server } from "socket.io"
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 { authorize } from '@thream/socketio-jwt'
import { Server } from "socket.io"
import { authorize } from "@thream/socketio-jwt"
const io = new Server(9000)
io.use(
authorize({
secret: 'your secret or public key',
onAuthentication: async decodedToken => {
secret: "your secret or public key",
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', {
auth: { token: `Bearer ${yourJWT}` }
const socket = io("http://localhost:9000", {
auth: { token: `Bearer ${yourJWT}` },
})
// Handling token expiration
socket.on('connect_error', (error) => {
if (error.data.type === 'UnauthorizedError') {
console.log('User token has expired')
socket.on("connect_error", (error) => {
if (isUnauthorizedError(error)) {
console.log("User token has expired")
}
})
// Listening to events
socket.on('messages', (data) => {
socket.on("messages", (data) => {
console.log(data)
})
```

View File

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

27138
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -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:typescript": "ts-standard",
"lint:markdown": "markdownlint-cli2",
"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/config-conventional": "12.1.4",
"@types/express": "4.17.13",
"@types/jest": "26.0.24",
"@types/jsonwebtoken": "8.5.4",
"@types/node": "16.4.1",
"@types/server-destroy": "1.0.1",
"axios": "0.21.1",
"editorconfig-checker": "4.0.2",
"express": "4.17.1",
"husky": "7.0.1",
"jest": "27.0.6",
"markdownlint-cli": "0.28.1",
"pinst": "2.1.6",
"rimraf": "3.0.2",
"semantic-release": "17.4.4",
"server-destroy": "1.0.1",
"socket.io": "4.1.3",
"socket.io-client": "4.1.3",
"ts-jest": "27.0.4",
"ts-standard": "10.0.0",
"typescript": "4.3.5"
"@commitlint/cli": "18.0.0",
"@commitlint/config-conventional": "18.0.0",
"@swc/cli": "0.1.62",
"@swc/core": "1.3.94",
"@tsconfig/strictest": "2.0.2",
"@types/jsonwebtoken": "9.0.4",
"@types/node": "20.8.7",
"@typescript-eslint/eslint-plugin": "6.9.0",
"@typescript-eslint/parser": "6.9.0",
"axios": "1.5.1",
"cross-env": "7.0.3",
"editorconfig-checker": "5.1.1",
"eslint": "8.52.0",
"eslint-config-conventions": "12.0.0",
"eslint-config-prettier": "9.0.0",
"eslint-plugin-import": "2.29.0",
"eslint-plugin-prettier": "5.0.1",
"eslint-plugin-promise": "6.1.1",
"eslint-plugin-unicorn": "48.0.1",
"fastify": "4.24.3",
"husky": "8.0.3",
"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"
}
}

View File

@ -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"
)
}

View File

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

View File

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

View File

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

View File

@ -1,16 +1,13 @@
import jwt, { Algorithm } from 'jsonwebtoken'
import { Socket } from 'socket.io'
import type { Algorithm } from "jsonwebtoken"
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(' ')
if (tokenSplitted.length !== 2 || tokenSplitted[0] !== 'Bearer') {
const tokenSplitted = token.split(" ")
if (tokenSplitted.length !== 2 || tokenSplitted[0] !== "Bearer") {
return next(
new UnauthorizedError('credentials_bad_format', {
message: 'Format is Authorization: Bearer [token]'
})
new UnauthorizedError("credentials_bad_format", {
message: "Format is Authorization: Bearer [token]",
}),
)
}
encodedToken = tokenSplitted[1]
}
if (encodedToken == null) {
return next(
new UnauthorizedError('credentials_required', {
message: 'no token provided'
})
new UnauthorizedError("credentials_required", {
message: "no token provided",
}),
)
}
socket.encodedToken = encodedToken
let keySecret: string | null = null
let decodedToken: any
if (typeof secret === 'string') {
let decodedToken: any = null
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', {
message: 'Unauthorized: Token is missing or invalid Bearer'
})
new UnauthorizedError("invalid_token", {
message: "Unauthorized: Token is missing or invalid Bearer",
}),
)
}
socket.decodedToken = decodedToken
if (onAuthentication != null) {
try {
socket.user = await onAuthentication(decodedToken)
} catch (err) {
return next(err)
} catch (error: any) {
return next(error)
}
}
return next()

View File

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

View File

@ -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,
"esModuleInterop": true,
"declaration": true,
"emitDeclarationOnly": true,
"declaration": true
}
}