socketio/socket.io
### [`v3.1.1`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#311-httpsgithubcomsocketiosocketiocompare310311-2021-02-03)
[Compare Source](https://togithub.com/socketio/socket.io/compare/3.1.0...3.1.1)
##### Bug Fixes
- properly parse the CONNECT packet in v2 compatibility mode ([6f4bd7f](https://togithub.com/socketio/socket.io/commit/6f4bd7f8e7c41a075a8014565330a77c38b03a8d))
- **typings:** add return types and general-case overload signatures ([#3776](https://togithub.com/socketio/socket.io/issues/3776)) ([9e8f288](https://togithub.com/socketio/socket.io/commit/9e8f288ca9f14f91064b8d3cce5946f7d23d407c))
- **typings:** update the types of "query", "auth" and "headers" ([4f2e9a7](https://togithub.com/socketio/socket.io/commit/4f2e9a716d9835b550c8fd9a9b429ebf069c2895))
### [`v3.1.0`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#310-httpsgithubcomsocketiosocketiocompare305310-2021-01-15)
[Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.5...3.1.0)
##### Features
- confirm a weak but matching ETag ([#3485](https://togithub.com/socketio/socket.io/issues/3485)) ([161091d](https://togithub.com/socketio/socket.io/commit/161091dd4c9e1b1610ac3d45d964195e63d92b94))
- **esm:** export the Namespace and Socket class ([#3699](https://togithub.com/socketio/socket.io/issues/3699)) ([233650c](https://togithub.com/socketio/socket.io/commit/233650c22209708b5fccc4349c38d2fa1b465d8f))
- add support for Socket.IO v2 clients ([9925746](https://togithub.com/socketio/socket.io/commit/9925746c8ee3a6522bd640b5d586c83f04f2f1ba))
- add room events ([155fa63](https://togithub.com/socketio/socket.io-adapter/commit/155fa6333a504036e99a33667dc0397f6aede25e))
##### Bug Fixes
- allow integers as event names ([1c220dd](https://togithub.com/socketio/socket.io-parser/commit/1c220ddbf45ea4b44bc8dbf6f9ae245f672ba1b9))
#### [3.0.5](https://togithub.com/socketio/socket.io/compare/3.0.4...3.0.5) (2021-01-05)
##### Bug Fixes
- properly clear timeout on connection failure ([170b739](https://togithub.com/socketio/socket.io/commit/170b739f147cb6c92b423729b877e242e376927d))
##### Reverts
- restore the socket middleware functionality ([bf54327](https://togithub.com/socketio/socket.io/commit/bf5432742158e4d5ba2722cff4a614967dffa5b9))
#### [3.0.4](https://togithub.com/socketio/socket.io/compare/3.0.3...3.0.4) (2020-12-07)
#### [3.0.3](https://togithub.com/socketio/socket.io/compare/3.0.2...3.0.3) (2020-11-19)
#### [3.0.2](https://togithub.com/socketio/socket.io/compare/3.0.1...3.0.2) (2020-11-17)
##### Bug Fixes
- merge Engine.IO options ([43705d7](https://togithub.com/socketio/socket.io/commit/43705d7a9149833afc69edc937ea7f8c9aabfeef))
#### [3.0.1](https://togithub.com/socketio/socket.io/compare/3.0.0...3.0.1) (2020-11-09)
##### Bug Fixes
- export ServerOptions and Namespace types ([#3684](https://togithub.com/socketio/socket.io/issues/3684)) ([f62f180](https://togithub.com/socketio/socket.io/commit/f62f180edafdd56d8a8a277e092bc66df0c5f07f))
- **typings:** update the signature of the emit method ([50671d9](https://togithub.com/socketio/socket.io/commit/50671d984a81535a6a15c704546ca7465e2ea295))
### [`v3.0.5`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#305-httpsgithubcomsocketiosocketiocompare304305-2021-01-05)
[Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.4...3.0.5)
##### Bug Fixes
- properly clear timeout on connection failure ([170b739](https://togithub.com/socketio/socket.io/commit/170b739f147cb6c92b423729b877e242e376927d))
##### Reverts
- restore the socket middleware functionality ([bf54327](https://togithub.com/socketio/socket.io/commit/bf5432742158e4d5ba2722cff4a614967dffa5b9))
### [`v3.0.4`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#304-httpsgithubcomsocketiosocketiocompare303304-2020-12-07)
[Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.3...3.0.4)
### [`v3.0.3`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#303-httpsgithubcomsocketiosocketiocompare302303-2020-11-19)
[Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.2...3.0.3)
### [`v3.0.2`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#302-httpsgithubcomsocketiosocketiocompare301302-2020-11-17)
[Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.1...3.0.2)
##### Bug Fixes
- merge Engine.IO options ([43705d7](https://togithub.com/socketio/socket.io/commit/43705d7a9149833afc69edc937ea7f8c9aabfeef))
### [`v3.0.1`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#301-httpsgithubcomsocketiosocketiocompare300301-2020-11-09)
[Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.0...3.0.1)
##### Bug Fixes
- export ServerOptions and Namespace types ([#3684](https://togithub.com/socketio/socket.io/issues/3684)) ([f62f180](https://togithub.com/socketio/socket.io/commit/f62f180edafdd56d8a8a277e092bc66df0c5f07f))
- **typings:** update the signature of the emit method ([50671d9](https://togithub.com/socketio/socket.io/commit/50671d984a81535a6a15c704546ca7465e2ea295))
### [`v3.0.0`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#300-httpsgithubcomsocketiosocketiocompare230300-2020-11-05)
[Compare Source](https://togithub.com/socketio/socket.io/compare/2.4.1...3.0.0)
##### Bug Fixes
- close clients with no namespace ([91cd255](https://togithub.com/socketio/socket.io/commit/91cd255ba76ff6a780c62740f9f5cd3a76f5d7c7))
##### Features
- emit an Error object upon middleware error ([54bf4a4](https://togithub.com/socketio/socket.io/commit/54bf4a44e9e896dfb64764ee7bd4e8823eb7dc7b))
- serve msgpack bundle ([aa7574f](https://togithub.com/socketio/socket.io/commit/aa7574f88471aa30ae472a5cddf1000a8baa70fd))
- add support for catch-all listeners ([5c73733](https://togithub.com/socketio/socket.io/commit/5c737339858d59eab4b5ee2dd6feff0e82c4fe5a))
- make Socket#join() and Socket#leave() synchronous ([129c641](https://togithub.com/socketio/socket.io/commit/129c6417bd818bc8b4e1b831644323876e627c13))
- remove prod dependency to socket.io-client ([7603da7](https://togithub.com/socketio/socket.io/commit/7603da71a535481e3fc60e38b013abf78516d322))
- move binary detection back to the parser ([669592d](https://togithub.com/socketio/socket.io/commit/669592d120409a5cf00f128070dee6d22259ba4f))
- add ES6 module export ([8b6b100](https://togithub.com/socketio/socket.io/commit/8b6b100c284ccce7d85e55659e3397f533916847))
- do not reuse the Engine.IO id ([2875d2c](https://togithub.com/socketio/socket.io/commit/2875d2cfdfa463e64cb520099749f543bbc4eb15))
- remove Server#set() method ([029f478](https://togithub.com/socketio/socket.io/commit/029f478992f59b1eb5226453db46363a570eea46))
- remove Socket#rooms object ([1507b41](https://togithub.com/socketio/socket.io/commit/1507b416d584381554d1ed23c9aaf3b650540071))
- remove the 'origins' option ([a8c0600](https://togithub.com/socketio/socket.io/commit/a8c06006098b512ba1b8b8df82777349db486f41))
- remove the implicit connection to the default namespace ([3289f7e](https://togithub.com/socketio/socket.io/commit/3289f7ec376e9ec88c2f90e2735c8ca8d01c0e97))
- throw upon reserved event names ([4bd5b23](https://togithub.com/socketio/socket.io/commit/4bd5b2339a66a5a675e20f689fff2e70ff12d236))
##### BREAKING CHANGES
- the Socket#use() method is removed (see [5c73733](https://togithub.com/socketio/socket.io/commit/5c737339858d59eab4b5ee2dd6feff0e82c4fe5a))
- Socket#join() and Socket#leave() do not accept a callback argument anymore.
Before:
```js
socket.join("room1", () => {
io.to("room1").emit("hello");
});
```
After:
```js
socket.join("room1");
io.to("room1").emit("hello");
// or await socket.join("room1"); for custom adapters
```
- the "connected" map is renamed to "sockets"
- the Socket#binary() method is removed, as this use case is now covered by the ability to provide your own parser.
- the 'origins' option is removed
Before:
```js
new Server(3000, {
origins: ["https://example.com"]
});
```
The 'origins' option was used in the allowRequest method, in order to
determine whether the request should pass or not. And the Engine.IO
server would implicitly add the necessary Access-Control-Allow-xxx
headers.
After:
```js
new Server(3000, {
cors: {
origin: "https://example.com",
methods: ["GET", "POST"],
allowedHeaders: ["content-type"]
}
});
```
The already existing 'allowRequest' option can be used for validation:
```js
new Server(3000, {
allowRequest: (req, callback) => {
callback(null, req.headers.referer.startsWith("https://example.com"));
}
});
```
- Socket#rooms is now a Set instead of an object
- Namespace#connected is now a Map instead of an object
- there is no more implicit connection to the default namespace:
```js
// client-side
const socket = io("/admin");
// server-side
io.on("connect", socket => {
// not triggered anymore
})
io.use((socket, next) => {
// not triggered anymore
});
io.of("/admin").use((socket, next) => {
// triggered
});
```
- the Server#set() method was removed
This method was kept for backward-compatibility with pre-1.0 versions.
Renovate configuration
:date: Schedule: "before 2am" (UTC).
:vertical_traffic_light: Automerge: Disabled by config. Please merge this manually once you are satisfied.
:recycle: Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
:no_bell: Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR contains the following updates:
^2.2.0
->^3.0.0
Release Notes
socketio/socket.io
### [`v3.1.1`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#311-httpsgithubcomsocketiosocketiocompare310311-2021-02-03) [Compare Source](https://togithub.com/socketio/socket.io/compare/3.1.0...3.1.1) ##### Bug Fixes - properly parse the CONNECT packet in v2 compatibility mode ([6f4bd7f](https://togithub.com/socketio/socket.io/commit/6f4bd7f8e7c41a075a8014565330a77c38b03a8d)) - **typings:** add return types and general-case overload signatures ([#3776](https://togithub.com/socketio/socket.io/issues/3776)) ([9e8f288](https://togithub.com/socketio/socket.io/commit/9e8f288ca9f14f91064b8d3cce5946f7d23d407c)) - **typings:** update the types of "query", "auth" and "headers" ([4f2e9a7](https://togithub.com/socketio/socket.io/commit/4f2e9a716d9835b550c8fd9a9b429ebf069c2895)) ### [`v3.1.0`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#310-httpsgithubcomsocketiosocketiocompare305310-2021-01-15) [Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.5...3.1.0) ##### Features - confirm a weak but matching ETag ([#3485](https://togithub.com/socketio/socket.io/issues/3485)) ([161091d](https://togithub.com/socketio/socket.io/commit/161091dd4c9e1b1610ac3d45d964195e63d92b94)) - **esm:** export the Namespace and Socket class ([#3699](https://togithub.com/socketio/socket.io/issues/3699)) ([233650c](https://togithub.com/socketio/socket.io/commit/233650c22209708b5fccc4349c38d2fa1b465d8f)) - add support for Socket.IO v2 clients ([9925746](https://togithub.com/socketio/socket.io/commit/9925746c8ee3a6522bd640b5d586c83f04f2f1ba)) - add room events ([155fa63](https://togithub.com/socketio/socket.io-adapter/commit/155fa6333a504036e99a33667dc0397f6aede25e)) ##### Bug Fixes - allow integers as event names ([1c220dd](https://togithub.com/socketio/socket.io-parser/commit/1c220ddbf45ea4b44bc8dbf6f9ae245f672ba1b9)) #### [3.0.5](https://togithub.com/socketio/socket.io/compare/3.0.4...3.0.5) (2021-01-05) ##### Bug Fixes - properly clear timeout on connection failure ([170b739](https://togithub.com/socketio/socket.io/commit/170b739f147cb6c92b423729b877e242e376927d)) ##### Reverts - restore the socket middleware functionality ([bf54327](https://togithub.com/socketio/socket.io/commit/bf5432742158e4d5ba2722cff4a614967dffa5b9)) #### [3.0.4](https://togithub.com/socketio/socket.io/compare/3.0.3...3.0.4) (2020-12-07) #### [3.0.3](https://togithub.com/socketio/socket.io/compare/3.0.2...3.0.3) (2020-11-19) #### [3.0.2](https://togithub.com/socketio/socket.io/compare/3.0.1...3.0.2) (2020-11-17) ##### Bug Fixes - merge Engine.IO options ([43705d7](https://togithub.com/socketio/socket.io/commit/43705d7a9149833afc69edc937ea7f8c9aabfeef)) #### [3.0.1](https://togithub.com/socketio/socket.io/compare/3.0.0...3.0.1) (2020-11-09) ##### Bug Fixes - export ServerOptions and Namespace types ([#3684](https://togithub.com/socketio/socket.io/issues/3684)) ([f62f180](https://togithub.com/socketio/socket.io/commit/f62f180edafdd56d8a8a277e092bc66df0c5f07f)) - **typings:** update the signature of the emit method ([50671d9](https://togithub.com/socketio/socket.io/commit/50671d984a81535a6a15c704546ca7465e2ea295)) ### [`v3.0.5`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#305-httpsgithubcomsocketiosocketiocompare304305-2021-01-05) [Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.4...3.0.5) ##### Bug Fixes - properly clear timeout on connection failure ([170b739](https://togithub.com/socketio/socket.io/commit/170b739f147cb6c92b423729b877e242e376927d)) ##### Reverts - restore the socket middleware functionality ([bf54327](https://togithub.com/socketio/socket.io/commit/bf5432742158e4d5ba2722cff4a614967dffa5b9)) ### [`v3.0.4`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#304-httpsgithubcomsocketiosocketiocompare303304-2020-12-07) [Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.3...3.0.4) ### [`v3.0.3`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#303-httpsgithubcomsocketiosocketiocompare302303-2020-11-19) [Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.2...3.0.3) ### [`v3.0.2`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#302-httpsgithubcomsocketiosocketiocompare301302-2020-11-17) [Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.1...3.0.2) ##### Bug Fixes - merge Engine.IO options ([43705d7](https://togithub.com/socketio/socket.io/commit/43705d7a9149833afc69edc937ea7f8c9aabfeef)) ### [`v3.0.1`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#301-httpsgithubcomsocketiosocketiocompare300301-2020-11-09) [Compare Source](https://togithub.com/socketio/socket.io/compare/3.0.0...3.0.1) ##### Bug Fixes - export ServerOptions and Namespace types ([#3684](https://togithub.com/socketio/socket.io/issues/3684)) ([f62f180](https://togithub.com/socketio/socket.io/commit/f62f180edafdd56d8a8a277e092bc66df0c5f07f)) - **typings:** update the signature of the emit method ([50671d9](https://togithub.com/socketio/socket.io/commit/50671d984a81535a6a15c704546ca7465e2ea295)) ### [`v3.0.0`](https://togithub.com/socketio/socket.io/blob/master/CHANGELOG.md#300-httpsgithubcomsocketiosocketiocompare230300-2020-11-05) [Compare Source](https://togithub.com/socketio/socket.io/compare/2.4.1...3.0.0) ##### Bug Fixes - close clients with no namespace ([91cd255](https://togithub.com/socketio/socket.io/commit/91cd255ba76ff6a780c62740f9f5cd3a76f5d7c7)) ##### Features - emit an Error object upon middleware error ([54bf4a4](https://togithub.com/socketio/socket.io/commit/54bf4a44e9e896dfb64764ee7bd4e8823eb7dc7b)) - serve msgpack bundle ([aa7574f](https://togithub.com/socketio/socket.io/commit/aa7574f88471aa30ae472a5cddf1000a8baa70fd)) - add support for catch-all listeners ([5c73733](https://togithub.com/socketio/socket.io/commit/5c737339858d59eab4b5ee2dd6feff0e82c4fe5a)) - make Socket#join() and Socket#leave() synchronous ([129c641](https://togithub.com/socketio/socket.io/commit/129c6417bd818bc8b4e1b831644323876e627c13)) - remove prod dependency to socket.io-client ([7603da7](https://togithub.com/socketio/socket.io/commit/7603da71a535481e3fc60e38b013abf78516d322)) - move binary detection back to the parser ([669592d](https://togithub.com/socketio/socket.io/commit/669592d120409a5cf00f128070dee6d22259ba4f)) - add ES6 module export ([8b6b100](https://togithub.com/socketio/socket.io/commit/8b6b100c284ccce7d85e55659e3397f533916847)) - do not reuse the Engine.IO id ([2875d2c](https://togithub.com/socketio/socket.io/commit/2875d2cfdfa463e64cb520099749f543bbc4eb15)) - remove Server#set() method ([029f478](https://togithub.com/socketio/socket.io/commit/029f478992f59b1eb5226453db46363a570eea46)) - remove Socket#rooms object ([1507b41](https://togithub.com/socketio/socket.io/commit/1507b416d584381554d1ed23c9aaf3b650540071)) - remove the 'origins' option ([a8c0600](https://togithub.com/socketio/socket.io/commit/a8c06006098b512ba1b8b8df82777349db486f41)) - remove the implicit connection to the default namespace ([3289f7e](https://togithub.com/socketio/socket.io/commit/3289f7ec376e9ec88c2f90e2735c8ca8d01c0e97)) - throw upon reserved event names ([4bd5b23](https://togithub.com/socketio/socket.io/commit/4bd5b2339a66a5a675e20f689fff2e70ff12d236)) ##### BREAKING CHANGES - the Socket#use() method is removed (see [5c73733](https://togithub.com/socketio/socket.io/commit/5c737339858d59eab4b5ee2dd6feff0e82c4fe5a)) - Socket#join() and Socket#leave() do not accept a callback argument anymore. Before: ```js socket.join("room1", () => { io.to("room1").emit("hello"); }); ``` After: ```js socket.join("room1"); io.to("room1").emit("hello"); // or await socket.join("room1"); for custom adapters ``` - the "connected" map is renamed to "sockets" - the Socket#binary() method is removed, as this use case is now covered by the ability to provide your own parser. - the 'origins' option is removed Before: ```js new Server(3000, { origins: ["https://example.com"] }); ``` The 'origins' option was used in the allowRequest method, in order to determine whether the request should pass or not. And the Engine.IO server would implicitly add the necessary Access-Control-Allow-xxx headers. After: ```js new Server(3000, { cors: { origin: "https://example.com", methods: ["GET", "POST"], allowedHeaders: ["content-type"] } }); ``` The already existing 'allowRequest' option can be used for validation: ```js new Server(3000, { allowRequest: (req, callback) => { callback(null, req.headers.referer.startsWith("https://example.com")); } }); ``` - Socket#rooms is now a Set instead of an object - Namespace#connected is now a Map instead of an object - there is no more implicit connection to the default namespace: ```js // client-side const socket = io("/admin"); // server-side io.on("connect", socket => { // not triggered anymore }) io.use((socket, next) => { // not triggered anymore }); io.of("/admin").use((socket, next) => { // triggered }); ``` - the Server#set() method was removed This method was kept for backward-compatibility with pre-1.0 versions.Renovate configuration
:date: Schedule: "before 2am" (UTC).
:vertical_traffic_light: Automerge: Disabled by config. Please merge this manually once you are satisfied.
:recycle: Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
:no_bell: Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by WhiteSource Renovate. View repository job log here.