mirror of
https://github.com/Thream/socketio-jwt.git
synced 2024-07-21 09:38:31 +02:00
72 lines
2.4 KiB
Markdown
72 lines
2.4 KiB
Markdown
# 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.
|