277 Commits

Author SHA1 Message Date
ff6a84a8e1 fix: publish updated README 2022-09-09 11:41:42 +02:00
c7c152a554 build(deps): update latest 2022-09-09 11:39:27 +02:00
7977c42c20 build(deps): bump npm from 8.10.0 to 8.12.0 (#338) 2022-07-25 12:52:11 +02:00
05b9eea638 build(deps): bump semver-regex from 3.1.3 to 3.1.4 (#339) 2022-07-25 12:51:59 +02:00
e14b456d9a build(deps-dev): bump semantic-release from 19.0.2 to 19.0.3 (#340) 2022-07-25 12:51:41 +02:00
f85595224f build(deps): update latest 2022-05-12 21:26:33 +02:00
1247a9b5f0 chore: remove codecov 2022-05-12 21:24:15 +02:00
9a942c52c5 style: fix linting issue 2022-04-07 10:14:52 +02:00
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
559ad8bd6d ci: avoid duplicate runs 2022-03-01 09:02:21 +01:00
e68ed3c432 fix: emit types declaration 2022-02-19 10:36:34 +01:00
098475d64c feat: add isUnauthorizedError type guard
fixes #328
2022-02-18 17:20:59 +01:00
056c7b4807 build(deps-dev): bump @commitlint/config-conventional to 16.2.1 (#331) 2022-02-15 10:49:26 +01:00
25c74045a9 build(deps): bump engine.io from 6.1.0 to 6.1.2 (#334) 2022-02-15 10:49:08 +01:00
f68daca38b build(deps-dev): bump @commitlint/cli from 16.1.0 to 16.2.1 (#329) 2022-02-15 10:48:02 +01:00
f78f58cd4b build(deps-dev): bump axios from 0.25.0 to 0.26.0 (#330) 2022-02-15 10:47:36 +01:00
7eb3634286 build(deps-dev): bump @types/node from 17.0.16 to 17.0.18 (#333) 2022-02-15 10:47:22 +01:00
853aa301de build(deps-dev): bump markdownlint-cli from 0.31.0 to 0.31.1 (#326) 2022-02-10 11:23:08 +01:00
1d853e2457 build(deps-dev): bump jest from 27.5.0 to 27.5.1 (#325) 2022-02-09 17:45:56 +01:00
585e488471 build(deps-dev): bump @types/node from 17.0.15 to 17.0.16 (#324) 2022-02-08 12:41:14 +01:00
1088803ee2 build(deps-dev): bump jest from 27.4.7 to 27.5.0 (#322) 2022-02-07 15:39:46 +01:00
280d9eb485 build(deps-dev): bump @types/node from 17.0.14 to 17.0.15 (#321) 2022-02-07 15:37:48 +01:00
033a8be43e build(deps-dev): bump markdownlint-cli from 0.30.0 to 0.31.0 (#323) 2022-02-07 15:37:27 +01:00
8d2ff1b7c3 build(deps-dev): bump @types/node from 17.0.13 to 17.0.14 (#320) 2022-02-04 17:15:34 +01:00
91c9820846 build(deps): bump node-fetch from 2.6.6 to 2.6.7 (#319) 2022-01-31 10:41:23 +01:00
8b94866469 build(deps-dev): bump @types/node from 17.0.10 to 17.0.13 (#318) 2022-01-29 16:08:52 +01:00
911a5f20db build(deps-dev): bump typescript from 4.5.4 to 4.5.5 (#315) 2022-01-22 13:51:45 +01:00
56d3420c71 build(deps-dev): bump @types/node from 17.0.8 to 17.0.10 (#311) 2022-01-22 13:49:39 +01:00
025f8d9c3d build(deps-dev): bump axios from 0.24.0 to 0.25.0 (#310) 2022-01-22 13:44:26 +01:00
844cd7d138 build(deps-dev): bump @types/jsonwebtoken from 8.5.7 to 8.5.8 (#308) 2022-01-22 13:44:15 +01:00
6d9d36dea5 build(deps-dev): bump semantic-release from 18.0.1 to 19.0.2 (#312) 2022-01-22 13:44:04 +01:00
54bcaab4ea build(deps-dev): bump @commitlint/cli from 16.0.2 to 16.1.0 (#314) 2022-01-22 13:43:50 +01:00
87a2542abc build(deps-dev): bump ts-jest from 27.1.2 to 27.1.3 (#307) 2022-01-17 18:48:01 +01:00
c944d36e06 build(deps-dev): bump @types/jsonwebtoken from 8.5.6 to 8.5.7 (#306) 2022-01-15 00:10:34 +01:00
c6d6ef997e build(deps-dev): bump @commitlint/cli from 16.0.1 to 16.0.2 (#305) 2022-01-15 00:10:24 +01:00
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
d5447a5f29 build(deps-dev): bump jest from 27.4.5 to 27.4.7 (#302) 2022-01-07 15:45:27 +01:00
1f50d858e5 build(deps-dev): bump @types/node from 17.0.5 to 17.0.8 (#301) 2022-01-07 15:45:05 +01:00
5949d0e4e0 build(deps-dev): bump socket.io from 4.4.0 to 4.4.1 (#304) 2022-01-07 15:44:47 +01:00
4ac3dfd37f build(deps-dev): bump @types/jest from 27.0.3 to 27.4.0 (#297) 2022-01-01 02:44:53 +01:00
8c6bd1fe7d build(deps): bump actions/setup-node from 2.5.0 to 2.5.1 (#296) 2021-12-29 11:08:40 +01:00
8165c13a64 chore: recreate package-lock.json 2021-12-28 15:11:05 +01:00
54f11e3736 build(deps-dev): bump @commitlint/cli from 15.0.0 to 16.0.1 (#295) 2021-12-28 15:07:17 +01:00
f715eb2356 build(deps-dev): bump typescript from 4.5.2 to 4.5.4 (#284) 2021-12-28 15:06:21 +01:00
ee97a6decb build(deps-dev): bump @commitlint/config-conventional 16.0.0 (#294) 2021-12-28 15:06:05 +01:00
c92e84b81e build(deps-dev): bump jest from 27.4.3 to 27.4.5 (#283) 2021-12-28 15:05:48 +01:00
a470151958 build(deps-dev): bump express from 4.17.1 to 4.17.2 (#287) 2021-12-28 15:05:27 +01:00
7b8dc0c03f build(deps-dev): bump ts-jest from 27.1.0 to 27.1.2 (#288) 2021-12-28 15:05:10 +01:00
112be97015 build(deps-dev): bump @types/node from 16.11.11 to 17.0.5 (#293) 2021-12-28 15:04:58 +01:00
6f2f301562 build(deps-dev): bump ts-jest from 27.0.7 to 27.1.0 (#278) 2021-12-07 20:43:37 +01:00
a78c770a52 build(deps-dev): bump jest from 27.3.1 to 27.4.3 (#277) 2021-12-04 18:04:58 +01:00
24489d5e55 build(deps): bump actions/setup-node from 2.4.1 to 2.5.0 (#273) 2021-11-30 14:52:49 +01:00
64ef87b2a2 build(deps-dev): bump semantic-release from 18.0.0 to 18.0.1 (#272) 2021-11-30 14:52:36 +01:00
1b9c39bd82 build(deps-dev): bump @types/node from 16.11.9 to 16.11.11 (#274) 2021-11-30 14:52:23 +01:00
df4522c0c7 build(deps-dev): bump markdownlint-cli from 0.29.0 to 0.30.0 (#270) 2021-11-30 14:52:11 +01:00
1b079565bc build(deps-dev): bump @types/node from 16.11.8 to 16.11.9 (#269) 2021-11-19 21:53:46 +01:00
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
b0ab7a1ef3 build(deps-dev): bump @types/jest from 27.0.2 to 27.0.3 (#265) 2021-11-19 14:37:37 +01:00
b24597ddc7 build(deps-dev): bump @types/node from 16.11.7 to 16.11.8 (#267) 2021-11-19 14:37:21 +01:00
4035af075f build(deps-dev): bump socket.io from 4.3.2 to 4.4.0 (#268) 2021-11-19 14:37:12 +01:00
0cee31c8aa build(deps-dev): bump @commitlint/cli from 14.1.0 to 15.0.0 (#261) 2021-11-18 19:28:47 +01:00
3d52581092 build(deps-dev): bump @types/jsonwebtoken from 8.5.5 to 8.5.6 (#260) 2021-11-18 19:28:37 +01:00
74de828af7 build(deps-dev): bump ts-standard from 10.0.0 to 11.0.0 (#263) 2021-11-18 19:28:27 +01:00
9a525578e1 build(deps-dev): bump @commitlint/config-conventional to 15.0.0 (#262) 2021-11-18 18:22:40 +01:00
b537a4c594 build(deps-dev): bump typescript from 4.4.4 to 4.5.2 (#264) 2021-11-18 18:22:16 +01:00
c2229809f4 build(deps-dev): bump @types/node from 16.11.6 to 16.11.7 (#258) 2021-11-09 15:16:44 +01:00
8042db1eb3 build(deps-dev): bump socket.io from 4.3.1 to 4.3.2 (#259) 2021-11-09 15:16:25 +01:00
af3ae33e24 build(deps-dev): bump @commitlint/config-conventional to 14.1.0 (#256) 2021-11-05 23:31:15 +01:00
21dd8971ad build(deps-dev): bump @commitlint/cli from 13.2.1 to 14.1.0 (#257) 2021-11-05 23:28:18 +01:00
020220210b build(deps-dev): bump @types/node from 16.11.2 to 16.11.6 (#255) 2021-10-28 11:09:16 +02:00
8295acaba3 build(deps-dev): bump axios from 0.21.4 to 0.24.0 (#254) 2021-10-28 11:09:00 +02:00
cfc166cd48 build(deps-dev): bump @types/node from 16.11.1 to 16.11.2 (#252) 2021-10-23 12:48:49 +02:00
c0b7d2128f build(deps-dev): bump jest from 27.2.5 to 27.3.1 (#250) 2021-10-21 10:37:03 +02:00
f594c17097 build(deps-dev): bump husky from 7.0.2 to 7.0.4 (#251) 2021-10-21 10:33:22 +02:00
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
6b79e86277 build(deps-dev): bump ts-jest from 27.0.5 to 27.0.7 (#246) 2021-10-18 16:00:08 +02:00
257f967ba6 build(deps-dev): bump socket.io from 4.3.0 to 4.3.1 (#247) 2021-10-18 15:59:55 +02:00
5c3d12a201 build(deps-dev): bump @types/node from 16.11.0 to 16.11.1 (#248) 2021-10-18 15:59:40 +02:00
bea0548d7d build(deps-dev): bump socket.io from 4.2.0 to 4.3.0 (#242) 2021-10-16 00:05:14 +02:00
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
ece3c53fbf build(deps-dev): bump @types/node from 16.10.3 to 16.11.0 (#243) 2021-10-16 00:02:26 +02:00
094b1cd257 build(deps-dev): bump typescript from 4.4.3 to 4.4.4 (#239) 2021-10-16 00:02:16 +02:00
520df540b5 build(deps-dev): bump @commitlint/cli from 13.2.0 to 13.2.1 (#235) 2021-10-11 19:31:09 +02:00
162ca4401d build(deps-dev): bump jest from 27.2.4 to 27.2.5 (#236) 2021-10-11 19:30:59 +02:00
f88772710d build(deps-dev): bump markdownlint-cli from 0.28.1 to 0.29.0 (#233) 2021-10-07 07:36:23 +02:00
2f696bca36 build(deps-dev): bump @types/node from 16.10.2 to 16.10.3 (#234) 2021-10-07 07:36:09 +02:00
336cc8d6a6 build(deps-dev): bump jest from 27.2.2 to 27.2.4 (#230) 2021-09-30 21:12:06 +02:00
b48136818e build(deps-dev): bump @types/node from 16.10.1 to 16.10.2 (#229) 2021-09-30 21:11:55 +02:00
4de72a1b3d build(deps-dev): bump @commitlint/config-conventional (#226) 2021-09-28 17:03:30 +02:00
d6785b99d2 build(deps): bump actions/setup-node from 2.4.0 to 2.4.1 (#225) 2021-09-28 17:03:03 +02:00
8b1fcf51fc build(deps-dev): bump @commitlint/cli from 13.1.0 to 13.2.0 (#227) 2021-09-28 17:02:39 +02:00
e9e69ea210 build(deps-dev): bump @types/node from 16.9.6 to 16.10.1 (#223) 2021-09-27 19:38:54 +02:00
6996f3aef1 build(deps-dev): bump jest from 27.2.1 to 27.2.2 (#224) 2021-09-27 19:38:44 +02:00
2769000be6 build(deps-dev): bump @types/node from 16.9.4 to 16.9.6 (#221) 2021-09-23 11:04:49 +02:00
b87cab898f build(deps-dev): bump @types/jest from 27.0.1 to 27.0.2 (#222) 2021-09-23 11:04:37 +02:00
3b644a4682 build(deps): bump codecov/codecov-action from 2.0.3 to 2.1.0 (#215) 2021-09-21 16:47:05 +02:00
33c6027c01 build(deps-dev): bump @types/node from 16.7.10 to 16.9.4 (#218) 2021-09-21 16:46:50 +02:00
a747280e1d build(deps-dev): bump typescript from 4.4.2 to 4.4.3 (#214) 2021-09-21 16:45:29 +02:00
44e60d10b0 build(deps-dev): bump semantic-release from 17.4.7 to 18.0.0 (#219) 2021-09-21 16:45:12 +02:00
927d5dc5c1 build(deps-dev): bump jest from 27.1.0 to 27.2.1 (#220) 2021-09-21 16:44:59 +02:00
22a35720ff build(deps-dev): bump axios from 0.21.1 to 0.21.4 (#209) 2021-09-21 16:44:45 +02:00
c461a15566 build(deps-dev): bump socket.io from 4.1.3 to 4.2.0 (#203) 2021-09-01 15:22:08 +02:00
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
075d67b7aa build(deps-dev): bump @types/node from 16.7.3 to 16.7.10 (#206) 2021-09-01 15:20:51 +02:00
2e2ad556d8 docs: remove CHANGELOG.md as we're now using semantic-release 2021-08-27 17:21:18 +02:00
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
5a7d281798 build(deps): bump codecov/codecov-action from 2.0.2 to 2.0.3 (#197) 2021-08-27 13:06:27 +02:00
6fb3dfef40 build(deps-dev): bump husky from 7.0.1 to 7.0.2 (#198) 2021-08-27 13:06:11 +02:00
37824f15e0 build(deps-dev): bump semantic-release from 17.4.6 to 17.4.7 (#199) 2021-08-27 13:05:58 +02:00
f2f064e03a build(deps-dev): bump @types/node from 16.7.1 to 16.7.2 (#200) 2021-08-27 13:05:46 +02:00
1ea767e551 build(deps-dev): bump semantic-release from 17.4.5 to 17.4.6 (#196) 2021-08-24 11:56:45 +02:00
09c4fe89be build(deps-dev): bump @types/node from 16.6.1 to 16.7.1 (#195) 2021-08-23 12:04:19 +02:00
986f7b8cdb build(deps-dev): bump @types/jsonwebtoken from 8.5.4 to 8.5.5 (#194) 2021-08-20 21:06:24 +02:00
6fd7dc60d7 build(deps-dev): bump semantic-release from 17.4.4 to 17.4.5 (#192) 2021-08-18 14:01:25 +02:00
4408e6e18c build(deps-dev): bump ts-jest from 27.0.4 to 27.0.5 (#191) 2021-08-18 14:01:13 +02:00
fdc7ee7f06 build(deps-dev): bump @types/node from 16.6.0 to 16.6.1 (#189) 2021-08-16 17:08:16 +02:00
9d5981f403 build(deps-dev): bump @types/jest from 27.0.0 to 27.0.1 (#190) 2021-08-16 17:08:05 +02:00
1409c25824 build(deps-dev): bump @commitlint/config-conventional (#174) 2021-08-12 11:17:28 +02:00
c82aa67e4e build(deps): bump actions/setup-node from 2.3.0 to 2.4.0 (#184) 2021-08-12 11:16:03 +02:00
2dddbe3d94 build(deps): bump codecov/codecov-action from 2.0.1 to 2.0.2 (#173) 2021-08-12 11:15:51 +02:00
6d02644d60 build(deps-dev): bump @commitlint/cli from 12.1.4 to 13.1.0 (#175) 2021-08-12 11:15:31 +02:00
3908f1e6c4 build(deps-dev): bump @types/jest from 26.0.24 to 27.0.0 (#187) 2021-08-12 11:07:00 +02:00
5cee6e17cd build(deps-dev): bump @types/node from 16.4.1 to 16.6.0 (#188) 2021-08-12 11:06:47 +02:00
9eedd5afbd chore: add semantic-release
close #153
2021-07-23 23:15:52 +02:00
dff86f7bda build(deps): bump jest from 26.6.3 to 27.0.6
close #128
2021-07-23 23:00:25 +02:00
a41881744a fix(types): onAuthorization can return a string 2021-07-23 22:54:07 +02:00
15f5c60b27 build(deps-dev): bump @types/node to 16.4.1 (#171) 2021-07-23 08:49:11 +02:00
56fb31edf6 build(deps-dev): bump markdownlint-cli from 0.27.1 to 0.28.1 (#172) 2021-07-23 08:34:29 +02:00
c08c431e6a build(deps): bump wagoid/commitlint-github-action to 4.1.1 (#167) 2021-07-22 08:07:00 +02:00
4ae9f519c5 build(deps): bump codecov/codecov-action from 1.5.2 to 2.0.1 (#168) 2021-07-22 08:06:17 +02:00
e4dcdf9928 build(deps): bump actions/setup-node from 2.2.0 to 2.3.0 (#169) 2021-07-22 08:05:56 +02:00
f08a6e4f62 build(deps-dev): bump socket.io-client from 4.1.2 to 4.1.3 (#161) 2021-07-18 00:33:11 +02:00
18df1dd19f build(deps-dev): bump socket.io from 4.1.2 to 4.1.3 (#162) 2021-07-16 23:25:29 +02:00
86cac11108 build(deps): bump wagoid/commitlint-github-action to 4.0.2 (#165) 2021-07-16 23:25:14 +02:00
170ad34da3 build(deps-dev): bump @types/jsonwebtoken from 8.5.3 to 8.5.4 (#155) 2021-07-07 21:40:27 +02:00
b5460b95ee build(deps-dev): bump @types/express from 4.17.12 to 4.17.13 (#156) 2021-07-07 21:40:16 +02:00
b1ab84e610 build(deps-dev): bump husky from 7.0.0 to 7.0.1 (#157) 2021-07-07 21:40:03 +02:00
b56248919e build(deps-dev): bump @types/jsonwebtoken to 8.5.3 (#152) 2021-07-02 10:19:49 +02:00
464381813f build(deps-dev): bump husky from 6.0.0 to 7.0.0 (#149) 2021-07-01 09:33:45 +02:00
6dc3696910 build(deps): bump actions/setup-node from 2.1.5 to 2.2.0 (#148) 2021-07-01 09:27:46 +02:00
e500fd3862 build(deps-dev): bump typescript to 4.3.5 (#150) 2021-07-01 09:03:53 +02:00
30aea8120a build(deps-dev): bump @types/jsonwebtoken to 8.5.2 (#142) 2021-06-23 13:30:42 +02:00
87d3af481e build(deps-dev): bump release-it to 14.10.0 (#144) 2021-06-23 13:30:25 +02:00
8867b9914e build(deps-dev): bump @release-it/conventional-changelog to 3.0.1 (#137) 2021-06-18 18:35:18 +02:00
8ae78c6732 build(deps-dev): bump typescript to 4.3.4 (#140) 2021-06-18 18:34:30 +02:00
def5b56184 build(deps-dev): bump release-it from 14.8.0 to 14.9.0 (#138)
Bumps [release-it](https://github.com/release-it/release-it) from 14.8.0 to 14.9.0.
- [Release notes](https://github.com/release-it/release-it/releases)
- [Changelog](https://github.com/release-it/release-it/blob/master/CHANGELOG.md)
- [Commits](https://github.com/release-it/release-it/compare/14.8.0...14.9.0)

---
updated-dependencies:
- dependency-name: release-it
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-15 23:34:11 +02:00
983d18ee09 build(deps): bump codecov/codecov-action from 1.5.0 to 1.5.2 (#136) 2021-06-12 22:03:42 +02:00
16f632d1b4 build(deps-dev): bump release-it from 14.7.0 to 14.8.0 (#134) 2021-06-12 22:03:31 +02:00
65bc3314cc chore: ci pass again (update jest later) 2021-05-28 10:13:00 +02:00
d6bd5e5cd7 build(deps-dev): bump typescript from 4.2.4 to 4.3.2 (#126) 2021-05-28 09:18:22 +02:00
96a41659bd build(deps): bump actions/cache from 2.1.5 to 2.1.6 (#127) 2021-05-28 09:18:03 +02:00
e5fca7e5ee build(deps-dev): bump jest from 26.6.3 to 27.0.1 (#123) 2021-05-26 18:45:48 +02:00
da40d6b1fd build(deps-dev): bump @types/express from 4.17.11 to 4.17.12 (#124) 2021-05-26 18:45:33 +02:00
219094da40 build(deps-dev): bump release-it from 14.6.2 to 14.7.0 (#122) 2021-05-25 18:07:56 +02:00
6361bd8782 build(deps-dev): bump @types/node from 15.6.0 to 15.6.1 (#121) 2021-05-25 18:07:33 +02:00
59efee7c37 build(deps-dev): bump @types/node from 15.3.1 to 15.6.0 (#120) 2021-05-24 11:29:11 +02:00
07c96e876b build(deps-dev): bump @types/node to 15.3.1 (#119) 2021-05-20 15:02:21 +02:00
ae08cc6e65 build(deps-dev): bump socket.io from 4.1.1 to 4.1.2 (#117) 2021-05-20 15:02:03 +02:00
3bae2e2bbf build(deps): bump wagoid/commitlint-github-action to 3.1.4 (#118) 2021-05-20 15:01:46 +02:00
47e69050e5 build(deps-dev): bump socket.io-client from 4.1.1 to 4.1.2 (#116) 2021-05-19 19:58:38 +02:00
9851fb319d build(deps-dev): bump @types/node from 15.0.3 to 15.3.0 (#115) 2021-05-17 16:29:51 +02:00
73fc64b9e5 build(deps-dev): bump @commitlint/cli from 12.1.1 to 12.1.4 (#112) 2021-05-15 15:59:19 +02:00
e300799e99 build(deps-dev): bump @commitlint/config-conventional (#114) 2021-05-13 13:37:14 +02:00
f6755c7d12 build(deps-dev): bump @types/node from 15.0.2 to 15.0.3 (#113) 2021-05-13 13:37:01 +02:00
5e16b06575 build(deps-dev): bump socket.io from 4.1.0 to 4.1.1 (#111) 2021-05-13 13:36:49 +02:00
a5468fdfae build(deps-dev): bump socket.io-client from 4.1.0 to 4.1.1 (#110) 2021-05-12 16:41:27 +02:00
4b86c778bf build(deps): bump codecov/codecov-action from 1 to 1.5.0 (#108) 2021-05-12 16:41:17 +02:00
a14e6e5ab1 build(deps): bump actions/checkout from 2 to 2.3.4 (#109) 2021-05-12 16:41:03 +02:00
927f021941 build(deps-dev): bump socket.io from 4.0.1 to 4.1.0 (#107) 2021-05-11 21:18:26 +02:00
344f71ced1 build(deps-dev): bump socket.io-client from 4.0.1 to 4.1.0 (#106) 2021-05-11 21:02:35 +02:00
3ce4b14d03 build(deps-dev): bump release-it from 14.6.1 to 14.6.2 (#103) 2021-05-11 18:29:05 +02:00
d11cbc3ffb build(deps): bump wagoid/commitlint-github-action from v3.1.0 to v3.1.3 (#105) 2021-05-11 18:28:53 +02:00
31ba9b48b5 build(deps-dev): bump ts-jest from 26.5.5 to 26.5.6 (#100) 2021-05-11 18:28:37 +02:00
88eba43f83 build(deps-dev): bump @types/node from 15.0.1 to 15.0.2 (#99) 2021-05-11 18:28:27 +02:00
9330edd3bc build(deps-dev): bump @types/node from 15.0.0 to 15.0.1 (#97) 2021-05-03 19:25:44 +02:00
2412e2e5fc build(deps-dev): bump @types/jest from 26.0.22 to 26.0.23 (#95) 2021-04-27 09:32:05 +02:00
7cfab50330 build(deps-dev): bump @types/node from 14.14.41 to 15.0.0 (#96) 2021-04-27 09:31:54 +02:00
644e3a52b7 build(deps-dev): bump ts-jest from 26.5.4 to 26.5.5 (#91) 2021-04-18 22:03:14 +02:00
1f912feda1 build(deps-dev): bump @types/node from 14.14.39 to 14.14.41 (#92) 2021-04-18 22:02:59 +02:00
6dcb8cbd49 build(deps-dev): bump @types/node from 14.14.37 to 14.14.39 (#90) 2021-04-15 18:17:33 +02:00
a93271bcec build(deps-dev): bump release-it from 14.5.1 to 14.6.1 (#88) 2021-04-14 14:10:38 +02:00
68e02a6ad5 build(deps): bump actions/cache from v2.1.4 to v2.1.5 (#89) 2021-04-14 14:10:26 +02:00
efb2b72572 build(deps-dev): bump typescript from 4.2.3 to 4.2.4 (#87) 2021-04-08 10:04:03 +02:00
4c869ba0ea build(deps): bump wagoid/commitlint-github-action from v3.0.8 to v3.1.0 (#86) 2021-04-07 19:36:16 +02:00
79c88b928b build(deps): bump wagoid/commitlint-github-action from v3.0.7 to v3.0.8 (#85) 2021-04-05 10:18:27 +02:00
f0f58630d9 build(deps-dev): bump @commitlint/config-conventional (#81) 2021-04-03 09:55:26 +02:00
cf81ca58fc build(deps-dev): bump @commitlint/cli from 12.0.1 to 12.1.1 (#82) 2021-04-03 09:53:19 +02:00
1255f7545e build(deps-dev): bump release-it from 14.5.0 to 14.5.1 (#83) 2021-04-03 09:53:08 +02:00
8570861d16 build(deps-dev): bump socket.io-client from 4.0.0 to 4.0.1 (#79) 2021-04-03 09:52:57 +02:00
f90cddc4a4 build(deps): bump wagoid/commitlint-github-action from v3.0.6 to v3.0.7 (#84) 2021-04-03 09:52:41 +02:00
f260bc793b build(deps-dev): bump socket.io from 4.0.0 to 4.0.1 (#78) 2021-04-01 13:24:20 +02:00
089ca1b67e build(deps-dev): bump editorconfig-checker from 4.0.1 to 4.0.2 (#80) 2021-04-01 13:24:04 +02:00
6696d1fa0a build(deps-dev): bump husky from 5.2.0 to 6.0.0 (#76) 2021-03-29 18:58:23 +02:00
d4d4adac31 build(deps-dev): bump @types/node from 14.14.36 to 14.14.37 (#77) 2021-03-29 18:58:10 +02:00
c8723a736e build(deps-dev): bump @types/node from 14.14.35 to 14.14.36 (#75) 2021-03-27 15:04:27 +01:00
38a5036623 build(deps-dev): bump @types/jest from 26.0.21 to 26.0.22 (#74) 2021-03-27 15:04:13 +01:00
f1866e290d build(deps-dev): bump release-it from 14.4.1 to 14.5.0 (#72) 2021-03-23 10:39:21 +01:00
47d74534ea build(deps-dev): bump husky from 5.1.3 to 5.2.0 (#73) 2021-03-23 10:39:04 +01:00
0d0109be52 chore: add editorconfig-checker 2021-03-19 14:07:21 +01:00
85953cdcce build(deps-dev): bump ts-jest from 26.5.3 to 26.5.4 (#70) 2021-03-18 16:31:12 +01:00
da2be10ed4 build(deps-dev): bump @types/jest from 26.0.20 to 26.0.21 (#71) 2021-03-18 16:30:58 +01:00
1bb3e0174f build(deps-dev): bump @types/jsonwebtoken from 8.5.0 to 8.5.1 (#69) 2021-03-17 18:26:01 +01:00
a20ead358c build(deps-dev): bump @types/node from 14.14.34 to 14.14.35 (#68) 2021-03-17 18:25:06 +01:00
215593c6d6 build(deps-dev): bump @types/node from 14.14.33 to 14.14.34 (#67) 2021-03-15 19:09:26 +01:00
7380635760 build(deps-dev): bump socket.io-client from 3.1.2 to 4.0.0 (#66) 2021-03-11 16:09:32 +01:00
7f7dda651b build(deps-dev): bump socket.io from 3.1.2 to 4.0.0 (#65) 2021-03-11 16:05:38 +01:00
2512c046d2 build(deps-dev): bump @types/node from 14.14.32 to 14.14.33 (#64) 2021-03-10 14:24:11 +01:00
88bfd46c33 chore(release): v2.1.0 2021-03-08 14:37:14 +01:00
4b95cd4293 chore: improve config files 2021-03-08 14:33:53 +01:00
c7f64a6312 feat: add optional onAuthentication option to add user property in socket object (#62) 2021-03-08 14:10:42 +01:00
89518a45d5 build(deps-dev): bump @types/node from 14.14.31 to 14.14.32 (#63) 2021-03-08 13:45:56 +01:00
a5da945bb5 build(deps-dev): bump typescript from 4.2.2 to 4.2.3 (#61) 2021-03-05 14:48:27 +01:00
ce798241e5 build(deps-dev): bump ts-jest from 26.5.2 to 26.5.3 (#59) 2021-03-04 12:32:10 +01:00
8dfddbd5b4 build(deps): bump wagoid/commitlint-github-action from v3.0.1 to v3.0.6 (#58) 2021-03-03 13:21:11 +01:00
e353d2a1fe build(deps-dev): bump markdownlint-cli from 0.27.0 to 0.27.1 (#57) 2021-03-03 13:20:58 +01:00
5a02e25f86 build(deps-dev): bump markdownlint-cli from 0.26.0 to 0.27.0 (#55) 2021-03-02 11:44:26 +01:00
f9678604cc build(deps-dev): bump husky from 5.1.2 to 5.1.3 (#56) 2021-03-02 11:41:42 +01:00
c5121fb008 build(deps-dev): bump @commitlint/config-conventional (#54) 2021-03-01 11:40:39 +01:00
95e461540a build(deps-dev): bump @commitlint/cli from 12.0.0 to 12.0.1 (#52) 2021-03-01 11:37:06 +01:00
7687ddfe83 build(deps-dev): bump husky from 5.1.1 to 5.1.2 (#53) 2021-03-01 11:36:53 +01:00
565f83db9d ci(commitlint): add configFile 2021-02-26 11:02:14 +01:00
6953d6952b build(deps-dev): bump socket.io from 3.1.1 to 3.1.2 (#51) 2021-02-26 10:56:11 +01:00
3d109f362f build(deps-dev): bump socket.io-client from 3.1.1 to 3.1.2 (#50) 2021-02-26 10:55:31 +01:00
ced2f5db1e build(deps): bump wagoid/commitlint-github-action from v2 to v3 (#49) 2021-02-25 07:55:53 +01:00
0971dcc1bb build(deps-dev): bump ts-jest from 26.5.1 to 26.5.2 (#47) 2021-02-24 12:57:00 +01:00
a710630ccf build(deps-dev): bump typescript from 4.1.5 to 4.2.2 (#48) 2021-02-24 12:56:37 +01:00
e50e7ea00e build(deps-dev): bump @release-it/conventional-changelog (#45) 2021-02-23 11:11:26 +01:00
cff7892c3d build(deps-dev): bump husky from 5.1.0 to 5.1.1 (#44) 2021-02-23 11:11:08 +01:00
17232c18e1 build(deps-dev): bump pinst from 2.1.4 to 2.1.6 (#46) 2021-02-23 11:10:52 +01:00
8f896eb93b build(deps-dev): bump @commitlint/cli from 11.0.0 to 12.0.0 (#43) 2021-02-23 11:09:59 +01:00
814fc781e3 build(deps-dev): bump @commitlint/config-conventional (#42) 2021-02-23 11:09:19 +01:00
4291da1417 build(deps): update actions/setup-node requirement to v2.1.5 (#41) 2021-02-23 11:09:02 +01:00
ad86800d8c chore(release): v2.0.0 2021-02-22 13:07:40 +01:00
a14d4e937b feat: usage of auth option to send credentials
BREAKING CHANGE: extraHeaders with Authorization doesn't work anymore

See: https://socket.io/docs/v3/middlewares/#Sending-credentials
2021-02-22 13:00:53 +01:00
4ba3e3bccb build(deps-dev): bump @types/node from 14.14.30 to 14.14.31 (#38) 2021-02-22 11:09:41 +01:00
907b82fca9 build(deps-dev): bump release-it from 14.4.0 to 14.4.1 (#40) 2021-02-22 11:09:26 +01:00
4c469169f4 build(deps-dev): bump husky from 5.0.9 to 5.1.0 (#39) 2021-02-22 11:09:01 +01:00
d5f402df86 build(deps-dev): bump @types/node from 14.14.28 to 14.14.30 (#36) 2021-02-19 09:24:50 +01:00
d01bcc29fa docs: add authorize options 2021-02-18 20:14:56 +01:00
55a5f71b6e build(deps-dev): bump @types/node from 14.14.27 to 14.14.28 (#35) 2021-02-15 14:00:04 +01:00
7ccdb8f9a0 chore: general improvements of config files 2021-02-14 19:28:15 +01:00
b61ddd1872 build(deps-dev): bump @types/node from 14.14.25 to 14.14.26 (#33) 2021-02-12 09:14:26 +01:00
ac3b5177e5 build(deps-dev): bump typescript from 4.1.4 to 4.1.5 (#32) 2021-02-11 09:58:40 +01:00
0e8630d145 build(deps-dev): bump ts-jest from 26.5.0 to 26.5.1 (#30) 2021-02-10 12:20:15 +01:00
bb1daa2e28 build(deps-dev): bump typescript from 4.1.3 to 4.1.4 (#31) 2021-02-10 12:19:50 +01:00
17d7f264a4 build(deps-dev): bump husky from 4.3.8 to 5.0.9 (#29) 2021-02-09 20:22:40 +01:00
7f1c25ed98 build(deps): bump actions/cache from v2 to v2.1.4 (#28) 2021-02-08 14:57:20 +01:00
d9fa92cb1c build(deps-dev): bump @types/node from 14.14.22 to 14.14.25 (#27) 2021-02-04 14:36:58 +01:00
b08354f2b2 build(deps-dev): bump socket.io from 3.1.0 to 3.1.1 (#26) 2021-02-04 13:37:42 +01:00
06141ec89d build(deps-dev): bump @types/node from 14.14.22 to 14.14.24 (#25) 2021-02-04 13:37:00 +01:00
113df6f8f7 build(deps-dev): bump release-it from 14.2.2 to 14.3.0 (#24) 2021-02-04 13:36:26 +01:00
a761725e6b build(deps-dev): bump socket.io-client from 3.1.0 to 3.1.1 (#23) 2021-02-04 13:36:00 +01:00
f5a13c01b0 build(deps-dev): bump ts-jest from 26.4.4 to 26.5.0 (#22) 2021-02-01 18:16:22 +01:00
5e3f5c1871 chore(release): v1.1.1 2021-01-28 19:16:53 +01:00
af7ff4e8d9 test: fix typings in fixture keySecret 2021-01-28 19:12:46 +01:00
959652b3d3 docs(readme): key.getPublicKey() with jwks-rsa 2021-01-28 18:53:56 +01:00
c1a9213a52 fix(types): decodedToken in secret callback
close #21
2021-01-28 18:47:38 +01:00
4d73584e4e build(deps-dev): bump @types/node from 14.14.21 to 14.14.22 (#20) 2021-01-20 10:47:39 +01:00
486aab1ded build(deps-dev): bump husky from 4.3.7 to 4.3.8 (#19) 2021-01-18 14:19:07 +01:00
6d593ff804 build(deps-dev): bump @types/node from 14.14.20 to 14.14.21 (#18) 2021-01-15 09:10:23 +01:00
5fc5d73752 build(deps-dev): bump socket.io-client from 3.0.5 to 3.1.0 (#17) 2021-01-15 09:10:03 +01:00
a38975ca49 build(deps-dev): bump socket.io from 3.0.5 to 3.1.0 (#16) 2021-01-15 09:09:20 +01:00
cb2cc8c074 build(deps-dev): bump @types/express from 4.17.10 to 4.17.11 (#15) 2021-01-13 11:26:07 +01:00
b7e1fcde6d build(deps-dev): bump @types/express from 4.17.9 to 4.17.10 (#13) 2021-01-12 08:37:56 +01:00
fd79d99235 chore(release): v1.1.0 2021-01-07 14:32:55 +01:00
261e8d66e2 feat: add support for jwks-rsa (#1) 2021-01-07 14:30:37 +01:00
ca83ad4ba2 build(deps-dev): bump husky from 4.3.6 to 4.3.7 (#11) 2021-01-07 11:47:55 +01:00
6d0f23ef31 chore: fix package.json syntax error 2021-01-07 05:45:46 +01:00
8c8d38fd69 build(deps-dev): bump socket.io-client from 3.0.4 to 3.0.5 (#9) 2021-01-06 19:07:15 +01:00
544801d8ba build(deps-dev): bump socket.io from 3.0.4 to 3.0.5 (#8) 2021-01-06 19:06:38 +01:00
0c68ada2b1 build(deps-dev): bump @types/node from 14.14.19 to 14.14.20 (#7) 2021-01-05 08:32:12 +01:00
b0c0cf6ee0 build(deps-dev): bump @types/node from 14.14.17 to 14.14.19 (#5) 2021-01-04 14:36:25 +01:00
84b523f434 feat: improve types by extending socket.io module (#6) 2021-01-04 14:35:59 +01:00
abc1225189 docs: update code of conduct link 2021-01-02 18:35:26 +01:00
e87a335064 chore: ts-standard linting in scripts 2021-01-01 04:42:06 +01:00
89bfd83cfc build(deps-dev): bump @types/node from 14.14.16 to 14.14.17 (#2) 2020-12-31 13:11:15 +01:00
abbabc588e feat: add algorithms option 2020-12-30 14:50:56 +01:00
44 changed files with 25352 additions and 406 deletions

1
.commitlintrc.json Normal file
View File

@ -0,0 +1 @@
{ "extends": ["@commitlint/config-conventional"] }

15
.eslintrc.json Normal file
View File

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

1
.gitattributes vendored Normal file
View File

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

View File

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

View File

@ -1,20 +1,18 @@
---
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.
<!-- Please make sure your issue has not already been fixed. -->
Please place an x (no spaces - [x]) in all [ ] that apply.
-->
## Documentation
### Documentation :
<!-- Please uncomment the type of documentation problem this issue address -->
- [ ] Is Missing
- [ ] Is Confusing
- [ ] Has Typo errors
- [ ] Not Sure?
<!-- Documentation is Missing -->
<!-- Documentation is Confusing -->
<!-- Documentation has Typo errors -->
### Proposal
## Proposal

View File

@ -1,19 +1,20 @@
---
name: '✨ Feature Request'
about: 'Suggest a new feature idea.'
title: '[Feature]'
labels: 'feature request'
---
<!-- Please make sure your issue has not already been fixed. -->
### Description
## Description
<!-- A clear and concise description of the problem or missing capability... -->
### Describe the solution you'd like
## Describe the solution you'd like
<!-- If you have a solution in mind, please describe it. -->
### Describe alternatives you've considered
## Describe alternatives you've considered
<!-- Have you considered any alternative solutions or workarounds? -->

View File

@ -1,21 +1,20 @@
---
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.
<!-- Please make sure your issue has not already been fixed. -->
Please place an x (no spaces - [x]) in all [ ] that apply.
-->
## Type of Improvement
### Type of Improvement :
<!-- Please uncomment the type of improvements this issue address -->
- [ ] Files and Folders Structure
- [ ] Performance
- [ ] Refactoring code
- [ ] Tests
- [ ] Not Sure?
<!-- Files and Folders Structure -->
<!-- Performance -->
<!-- Refactoring code -->
<!-- Tests -->
<!-- Not Sure? -->
### Proposal
## Proposal

View File

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

View File

@ -1,27 +1,7 @@
<!--
<!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
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?
Before submitting your contribution, please take a moment to review this document:
https://github.com/Thream/socketio-jwt/blob/master/.github/CONTRIBUTING.md
## List any relevant issue numbers
Please place an x (no spaces - [x]) in all [ ] that apply.
-->
### What type of change does this PR introduce?
- [ ] Bugfix
- [ ] Feature
- [ ] Refactor
- [ ] Documentation
- [ ] Not Sure?
### Does this PR introduce breaking changes?
- [ ] Yes
- [ ] No
### List any relevant issue numbers:
### Description:
## Is there anything you'd like reviewers to focus on?

View File

@ -1,13 +0,0 @@
# For more information see: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: 'daily'
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: 'daily'

25
.github/workflows/build.yml vendored Normal file
View File

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

View File

@ -1,20 +0,0 @@
# For more information see: https://github.com/marketplace/actions/commit-linter
name: 'Lint Commit Messages'
on:
push:
branches: [master, develop]
pull_request_review:
branches: [master, develop]
types: [submitted]
jobs:
commitlint:
if: ${{ (github.event_name == 'push') || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved' && (github.event.review.author_association == 'COLLABORATOR' || github.event.review.author_association == 'MEMBER' || github.event.review.author_association == 'OWNER') && !github.event.pull_request.draft && github.event.pull_request.state == 'open') }}
runs-on: ubuntu-latest
steps:
- uses: 'actions/checkout@v2'
with:
fetch-depth: 0
- uses: 'wagoid/commitlint-github-action@v2'

28
.github/workflows/lint.yml vendored Normal file
View File

@ -0,0 +1,28 @@
name: 'Lint'
on:
push:
branches: [develop]
pull_request:
branches: [master, develop]
jobs:
lint:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.0.0'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.1.0'
with:
node-version: 'lts/*'
cache: 'npm'
- name: 'Install'
run: 'npm 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:prettier'

View File

@ -1,47 +0,0 @@
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
name: 'Node.js CI'
on:
push:
branches: [master, develop]
pull_request_review:
branches: [master, develop]
types: [submitted]
jobs:
ci_app:
if: ${{ (github.event_name == 'push') || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved' && (github.event.review.author_association == 'COLLABORATOR' || github.event.review.author_association == 'MEMBER' || github.event.review.author_association == 'OWNER') && !github.event.pull_request.draft && github.event.pull_request.state == 'open') }}
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x]
steps:
- uses: 'actions/checkout@v2'
- name: Use Node.js ${{ matrix.node-version }}
uses: 'actions/setup-node@v2.1.4'
with:
node-version: ${{ matrix.node-version }}
- name: 'Cache dependencies'
uses: 'actions/cache@v2'
with:
path: |
**/node_modules
key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
- name: 'Install dependencies'
run: 'npm install'
- name: 'Lint'
run: 'npm run lint'
- name: 'Build'
run: 'npm run build'
- name: 'Run the tests and generate coverage report'
run: 'npm test'
- name: 'Upload coverage to Codecov'
uses: 'codecov/codecov-action@v1'

View File

@ -1,30 +0,0 @@
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
name: 'Node.js Package'
on:
release:
types: [created]
jobs:
publish-npm:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v2'
- name: 'Cache dependencies'
uses: 'actions/cache@v2'
with:
path: '**/node_modules'
key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
- uses: 'actions/setup-node@v2.1.2'
with:
node-version: 14
registry-url: 'https://registry.npmjs.org/'
- run: 'npm install'
- run: 'npm run build'
- run: 'npm publish --access public'
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

29
.github/workflows/release.yml vendored Normal file
View File

@ -0,0 +1,29 @@
name: 'Release'
on:
push:
branches: [master]
jobs:
release:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.0.0'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.1.0'
with:
node-version: 'lts/*'
cache: 'npm'
- name: 'Install'
run: 'npm install'
- name: 'Build Package'
run: 'npm run build'
- name: 'Release'
run: 'npm run release'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

28
.github/workflows/test.yml vendored Normal file
View File

@ -0,0 +1,28 @@
name: 'Test'
on:
push:
branches: [develop]
pull_request:
branches: [master, develop]
jobs:
test:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.0.0'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.1.0'
with:
node-version: 'lts/*'
cache: 'npm'
- name: 'Install'
run: 'npm install'
- name: 'Build'
run: 'npm run build'
- name: 'Test'
run: 'npm run test'

34
.gitignore vendored
View File

@ -2,34 +2,34 @@
# dependencies
node_modules
.pnp
.pnp.js
.yarn
.npm
# production
build
.swc
# testing
coverage
# envs
.env
.env.production
.nyc_output
# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# lockfiles
package-lock.json
yarn.lock
pnpm-lock.yaml
# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace
# editors
.vscode
.theia
.idea
# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
# misc
.DS_Store

4
.husky/commit-msg Executable file
View File

@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
npm run lint:commit -- --edit

5
.husky/pre-commit Executable file
View File

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

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

10
.markdownlint-cli2.jsonc Normal file
View File

@ -0,0 +1,10 @@
{
"config": {
"default": true,
"MD013": false,
"MD033": false,
"MD041": false
},
"globs": ["**/*.{md,mdx}"],
"ignores": ["**/node_modules"]
}

1
.npmrc
View File

@ -1,2 +1 @@
package-lock=false
save-exact=true

5
.nycrc.json Normal file
View File

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

6
.prettierrc.json Normal file
View File

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

19
.releaserc.json Normal file
View File

@ -0,0 +1,19 @@
{
"branches": ["master"],
"plugins": [
[
"@semantic-release/commit-analyzer",
{
"preset": "conventionalcommits"
}
],
[
"@semantic-release/release-notes-generator",
{
"preset": "conventionalcommits"
}
],
"@semantic-release/npm",
"@semantic-release/github"
]
}

12
.swcrc Normal file
View File

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

9
.taprc Normal file
View File

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

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,2 +0,0 @@
install.no-lockfile true
save-exact true

View File

@ -1,9 +0,0 @@
# Changelog
## [1.0.1](https://github.com/Thream/socketio-jwt/compare/v1.0.0...v1.0.1) (2020-12-29)
- docs(readme): 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

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

110
README.md
View File

@ -1,30 +1,39 @@
<h1 align="center"><a href="https://www.npmjs.com/package/@thream/socketio-jwt">Thream/socketio-jwt</a></h1>
<h1 align="center">Thream/socketio-jwt</h1>
<p align="center">
<strong>Authenticate socket.io incoming connections with JWTs.</strong>
</p>
<p align="center">
<a href="https://github.com/Thream/socketio-jwt/actions?query=workflow%3A%22Node.js+CI%22"><img src="https://github.com/Thream/socketio-jwt/workflows/Node.js%20CI/badge.svg" alt="Node.js CI" /></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>
<a href="https://dependabot.com/"><img src="https://badgen.net/github/dependabot/Thream/socketio-jwt?icon=dependabot" alt="Dependabot badge" /></a>
<a href="https://www.npmjs.com/package/@thream/socketio-jwt"><img src="https://img.shields.io/npm/v/@thream/socketio-jwt.svg" alt="npm version"></a>
<a href="https://www.npmjs.com/package/ts-standard"><img alt="TypeScript Standard Style" src="https://camo.githubusercontent.com/f87caadb70f384c0361ec72ccf07714ef69a5c0a/68747470733a2f2f62616467656e2e6e65742f62616467652f636f64652532307374796c652f74732d7374616e646172642f626c75653f69636f6e3d74797065736372697074"/></a>
<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>
<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>
<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="./.github/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://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>
<a href="https://www.npmjs.com/package/@thream/socketio-jwt"><img src="https://img.shields.io/npm/v/@thream/socketio-jwt.svg" alt="npm version"></a>
</p>
## 📜 About
Authenticate socket.io incoming connections with JWTs.
Compatible with `socket.io >= 3.0`.
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
```
@ -44,30 +53,95 @@ io.use(
})
)
io.on('connection', async () => {
io.on('connection', async (socket) => {
// jwt payload of the connected client
console.log(socket.decodedToken)
const clients = await io.sockets.allSockets()
for (const clientId of clients) {
const client = io.sockets.sockets.get(clientId)
client.emit('messages', { message: 'Success!' })
// we can access the jwt payload of each connected client
console.log(client.decodedToken)
if (clients != null) {
for (const clientId of clients) {
const client = io.sockets.sockets.get(clientId)
client?.emit('messages', { message: 'Success!' })
// we can access the jwt payload of each connected client
console.log(client?.decodedToken)
}
}
})
```
### Server side with `jwks-rsa` (example)
```ts
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'
})
const io = new Server(9000)
io.use(
authorize({
secret: async (decodedToken) => {
const key = await client.getSigningKeyAsync(decodedToken.header.kid)
return key.getPublicKey()
}
})
)
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...
})
```
### Server side with `onAuthentication` (example)
```ts
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) => {
// 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) => {
// jwt payload of the connected client
console.log(socket.decodedToken)
// You can do the same things of the previous example there...
// user object returned in onAuthentication
console.log(socket.user)
})
```
### `authorize` options
- `secret` is a string containing the secret for HMAC algorithms, or a function that should fetch the secret or public key as shown in the example with `jwks-rsa`.
- `algorithms` (default: `HS256`)
- `onAuthentication` is a function that will be called with the `decodedToken` as a parameter after the token is authenticated. Return a value to add to the `user` property in the socket object.
### Client side
```ts
import { io } from 'socket.io-client'
import { isUnauthorizedError } from '@thream/socketio-jwt/UnauthorizedError.js'
// Require Bearer Tokens to be passed in as an Authorization Header
// Require Bearer Token
const socket = io('http://localhost:9000', {
extraHeaders: { Authorization: `Bearer ${yourJWT}` }
auth: { token: `Bearer ${yourJWT}` }
})
// Handling token expiration
socket.on('connect_error', (error) => {
if (error.data.type === 'UnauthorizedError') {
if (isUnauthorizedError(error)) {
console.log('User token has expired')
}
})
@ -82,7 +156,7 @@ socket.on('messages', (data) => {
Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.
The steps to contribute can be found in the [CONTRIBUTING.md](./.github/CONTRIBUTING.md) file.
The steps to contribute can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
## 📄 License

View File

@ -1 +0,0 @@
module.exports = { extends: ['@commitlint/config-conventional'] }

24496
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,8 @@
{
"name": "@thream/socketio-jwt",
"version": "1.0.1",
"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"
"node": ">=16.0.0"
},
"publishConfig": {
"access": "public"
},
"keywords": [
"socket",
@ -19,93 +24,64 @@
"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",
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
"pre-commit": "npm run lint"
}
},
"release-it": {
"git": {
"commitMessage": "chore(release): v${version}"
},
"github": {
"release": false
},
"npm": {
"publish": false
},
"hooks": {
"before:init": [
"npm run lint",
"npm run test"
]
},
"plugins": {
"@release-it/conventional-changelog": {
"preset": "angular",
"infile": "CHANGELOG.md"
}
}
},
"jest": {
"preset": "ts-jest",
"testEnvironment": "node",
"rootDir": "./src",
"collectCoverage": true,
"coverageDirectory": "../coverage/"
},
"ts-standard": {
"files": [
"./src/**/*.ts"
],
"envs": [
"node",
"jest"
]
},
"scripts": {
"build": "rimraf ./build && tsc",
"lint": "exit 0",
"format": "ts-standard --fix | snazzy",
"release": "release-it",
"test": "jest",
"test:watchAll": "jest --watchAll",
"test:clearCache": "jest --clearCache"
"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-cli2",
"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",
"postinstall": "husky install",
"prepublishOnly": "pinst --disable",
"postpublish": "pinst --enable"
},
"peerDependencies": {
"socket.io": "*"
"socket.io": ">=3.0.0"
},
"dependencies": {
"jsonwebtoken": "8.5.1"
},
"devDependencies": {
"@commitlint/cli": "11.0.0",
"@commitlint/config-conventional": "11.0.0",
"@release-it/conventional-changelog": "2.0.0",
"@types/express": "4.17.9",
"@types/jest": "26.0.19",
"@types/jsonwebtoken": "8.5.0",
"@types/node": "14.14.16",
"@types/server-destroy": "1.0.1",
"axios": "0.21.1",
"express": "4.17.1",
"husky": "4.3.6",
"jest": "26.6.3",
"release-it": "14.2.2",
"@commitlint/cli": "17.1.2",
"@commitlint/config-conventional": "17.1.0",
"@swc/cli": "0.1.57",
"@swc/core": "1.2.249",
"@types/jsonwebtoken": "8.5.9",
"@types/node": "18.7.16",
"@types/tap": "15.0.7",
"@typescript-eslint/eslint-plugin": "5.36.2",
"@typescript-eslint/parser": "5.36.2",
"axios": "0.27.2",
"c8": "7.12.0",
"editorconfig-checker": "4.0.2",
"eslint": "8.23.0",
"eslint-config-conventions": "4.0.0",
"eslint-config-prettier": "8.5.0",
"eslint-plugin-import": "2.26.0",
"eslint-plugin-prettier": "4.2.1",
"eslint-plugin-promise": "6.0.1",
"eslint-plugin-unicorn": "43.0.2",
"fastify": "4.5.3",
"husky": "8.0.1",
"lint-staged": "13.0.3",
"markdownlint-cli2": "0.5.1",
"pinst": "3.0.0",
"prettier": "2.7.1",
"rimraf": "3.0.2",
"server-destroy": "1.0.1",
"snazzy": "9.0.0",
"socket.io": "3.0.4",
"socket.io-client": "3.0.4",
"ts-jest": "26.4.4",
"ts-standard": "10.0.0",
"typescript": "4.1.3"
"semantic-release": "19.0.5",
"socket.io": "4.5.2",
"socket.io-client": "4.5.2",
"tap": "16.3.0",
"typescript": "4.8.3"
}
}

View File

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

View File

@ -1,69 +1,325 @@
import tap from 'tap'
import axios from 'axios'
import type { Socket } from 'socket.io-client'
import { io } from 'socket.io-client'
import { fixtureStart, fixtureStop } from './fixture'
import { isUnauthorizedError } from '../UnauthorizedError.js'
import type { Profile } from './fixture/index.js'
import {
API_URL,
fixtureStart,
fixtureStop,
getSocket,
basicProfile
} from './fixture/index.js'
describe('authorize', () => {
let token: string = ''
export const api = axios.create({
baseURL: API_URL,
headers: {
'Content-Type': 'application/json'
}
})
beforeEach((done) => {
jest.setTimeout(15_000)
fixtureStart(async () => {
const response = await axios.post('http://localhost:9000/login')
const secretCallback = async (): Promise<string> => {
return 'somesecret'
}
await tap.test('authorize', async (t) => {
await t.test('with secret as string in options', async (t) => {
let token = ''
let socket: Socket | null = null
t.beforeEach(async () => {
await fixtureStart()
const response = await api.post('/login', {})
token = response.data.token
done()
})
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'
)
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)
})
})
})
afterEach((done) => {
fixtureStop(done)
})
await t.test('with secret as callback in options', async (t) => {
let token = ''
let socket: Socket | null = null
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()
t.beforeEach(async () => {
await fixtureStart({ secret: secretCallback })
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', (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'
)
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)
})
})
})
it('should emit error with bad token format', (done) => {
const socket = io('http://localhost:9000', {
extraHeaders: { Authorization: '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()
})
})
await t.test('with onAuthentication callback in options', async (t) => {
let token = ''
let wrongToken = ''
let socket: Socket | null = null
it('should emit error with unauthorized handshake', (done) => {
const socket = io('http://localhost:9000', {
extraHeaders: { Authorization: 'Bearer testing' }
t.beforeEach(async () => {
await fixtureStart({
secret: secretCallback,
onAuthentication: (decodedToken: Profile) => {
if (!decodedToken.checkField) {
throw new Error('Check Field validation failed')
}
return {
email: decodedToken.email
}
}
})
const response = await api.post('/login', {})
token = response.data.token
const responseWrong = await api.post('/login-wrong', {})
wrongToken = responseWrong.data.token
})
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', {
extraHeaders: { Authorization: `Bearer ${token}` }
t.afterEach(async () => {
socket?.disconnect()
await fixtureStop()
})
socket.on('connect', () => {
socket.close()
done()
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'
)
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('should contains user properties', (t) => {
t.plan(2)
const socketServer = getSocket()
socketServer?.on('connection', (client: any) => {
t.equal(client.user.email, basicProfile.email)
t.pass()
})
socket = io(API_URL, {
auth: { token: `Bearer ${token}` }
})
socket.on('connect_error', async (error) => {
t.fail(error.message)
})
})
await t.test('should emit error when user validation fails', (t) => {
t.plan(2)
socket = io(API_URL, {
auth: { token: `Bearer ${wrongToken}` }
})
socket.on('connect_error', async (error) => {
try {
t.equal(error.message, 'Check Field validation failed')
t.pass()
} catch {
t.fail()
}
})
socket.on('connect', async () => {
t.fail()
})
})
})
})

View File

@ -1,48 +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 type { FastifyInstance } from 'fastify'
import fastify from 'fastify'
import { authorize } from '../../index'
import type { AuthorizeOptions } from '../../index.js'
import { authorize } from '../../index.js'
interface Socket {
io: null | SocketIoServer
init: (httpServer: HttpServer | HttpsServer) => void
interface FastifyIo {
instance: SocketIoServer
}
const socket: Socket = {
io: null,
init (httpServer) {
socket.io = new SocketIoServer(httpServer)
declare module 'fastify' {
export interface FastifyInstance {
io: FastifyIo
}
}
let server: HttpServer | null = null
export interface BasicProfile {
email: string
id: number
}
export const fixtureStart = (done: any): void => {
const options = { secret: 'aaafoo super sercret' }
const app = express()
app.use(express.json())
app.post('/login', (_req, res) => {
const profile = {
email: 'john@doe.com',
id: 123
}
const token = jwt.sign(profile, options.secret, { expiresIn: 60 * 60 * 5 })
return res.json({ token })
export interface Profile extends BasicProfile {
checkField: boolean
}
export const PORT = 9000
export const API_URL = `http://localhost:${PORT}`
export const basicProfile: BasicProfile = {
email: 'john@doe.com',
id: 123
}
let application: FastifyInstance | null = null
export const fixtureStart = async (
options: AuthorizeOptions = { secret: 'super secret' }
): Promise<void> => {
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
})
}
application = fastify()
application.post('/login', async (_request, reply) => {
const token = jwt.sign(profile, keySecret, {
expiresIn: 60 * 60 * 5
})
reply.statusCode = 201
return { token }
})
application.post('/login-wrong', async (_request, reply) => {
profile.checkField = false
const token = jwt.sign(profile, keySecret, {
expiresIn: 60 * 60 * 5
})
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 (err) {}
callback()
export const fixtureStop = async (): Promise<void> => {
await application?.close()
}
export const getSocket = (): SocketIoServer | undefined => {
return application?.io.instance
}

View File

@ -1,28 +1,49 @@
import type { Algorithm } from 'jsonwebtoken'
import jwt from 'jsonwebtoken'
import { Socket } from 'socket.io'
import type { Socket } from 'socket.io'
import { UnauthorizedError } from './UnauthorizedError'
import { UnauthorizedError } from './UnauthorizedError.js'
interface ExtendedError extends Error {
data?: any
declare module 'socket.io' {
interface Socket extends ExtendedSocket {}
}
interface ExtendedSocket {
encodedToken?: string
decodedToken?: any
user?: any
}
type SocketIOMiddleware = (
socket: Socket,
next: (err?: ExtendedError) => void
next: (error?: UnauthorizedError) => void
) => void
interface AuthorizeOptions {
secret: string
interface CompleteDecodedToken {
header: {
alg: Algorithm
[key: string]: any
}
payload: any
}
type SecretCallback = (
decodedToken: CompleteDecodedToken
) => Promise<string> | string
export interface AuthorizeOptions {
secret: string | SecretCallback
algorithms?: Algorithm[]
onAuthentication?: (decodedToken: any) => Promise<any> | any
}
export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
const { secret } = options
return (socket, next) => {
let token: string | null = null
const authorizationHeader = socket.request.headers.authorization
if (authorizationHeader != null) {
const tokenSplitted = authorizationHeader.split(' ')
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') {
return next(
new UnauthorizedError('credentials_bad_format', {
@ -30,20 +51,26 @@ export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
})
)
}
token = tokenSplitted[1]
encodedToken = tokenSplitted[1]
}
if (token == null) {
if (encodedToken == null) {
return next(
new UnauthorizedError('credentials_required', {
message: 'no token provided'
})
)
}
// Store encoded JWT
socket = Object.assign(socket, { encodedToken: token })
let payload: any
socket.encodedToken = encodedToken
let keySecret: string | null = null
let decodedToken: any
if (typeof secret === 'string') {
keySecret = secret
} else {
const completeDecodedToken = jwt.decode(encodedToken, { complete: true })
keySecret = await secret(completeDecodedToken as CompleteDecodedToken)
}
try {
payload = jwt.verify(token, secret)
decodedToken = jwt.verify(encodedToken, keySecret, { algorithms })
} catch {
return next(
new UnauthorizedError('invalid_token', {
@ -51,8 +78,14 @@ export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
})
)
}
// Store decoded JWT
socket = Object.assign(socket, { decodedToken: payload })
socket.decodedToken = decodedToken
if (onAuthentication != null) {
try {
socket.user = await onAuthentication(decodedToken)
} 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,23 +1,15 @@
{
"compilerOptions": {
"target": "ES2019",
"module": "commonjs",
"lib": ["ES2019"],
"target": "ESNext",
"module": "ESNext",
"lib": ["ESNext"],
"moduleResolution": "node",
"allowJs": false,
"checkJs": false,
"declaration": true,
"sourceMap": false,
"outDir": "./build",
"rootDir": "./src",
"removeComments": false,
"noEmitOnError": true,
"importHelpers": false,
"emitDeclarationOnly": true,
"declaration": true,
"strict": true,
"esModuleInterop": true,
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"forceConsistentCasingInFileNames": true,
"incremental": false
"skipLibCheck": true,
"esModuleInterop": true
}
}