chore(release): @socket.io/[email protected]

Author: darrachequesne

CHANGELOG.md

@@ -10,5 +10,6 @@ Here are the detailed changelogs for each package in this monorepo:
 | `socket.io`                    | [link](packages/socket.io/CHANGELOG.md)                 |
 | `socket.io-adapter`            | [link](packages/socket.io-adapter/CHANGELOG.md)         |
 | `socket.io-client`             | [link](packages/socket.io-client/CHANGELOG.md)          |
+| `@socket.io/cluster-engine`    | [link](packages/socket.io-cluster-engine/CHANGELOG.md)  |
 | `@socket.io/component-emitter` | [link](packages/socket.io-component-emitter/History.md) |
 | `socket.io-parser`             | [link](packages/socket.io-parser/CHANGELOG.md)          |

CONTRIBUTING.md

@@ -78,6 +78,7 @@ This repository is a [monorepo](https://en.wikipedia.org/wiki/Monorepo) which co
 | `socket.io`                    | The server-side implementation of the bidirectional channel, built on top on the `engine.io` package.                                 |
 | `socket.io-adapter`            | An extensible component responsible for broadcasting a packet to all connected clients, used by the `socket.io` package.              |
 | `socket.io-client`             | The client-side implementation of the bidirectional channel, built on top on the `engine.io-client` package.                          |
+| `@socket.io/cluster-engine`    | A cluster-friendly engine to share load between multiple Node.js processes (without sticky sessions)                                  |
 | `@socket.io/component-emitter` | An `EventEmitter` implementation, similar to the one provided by [Node.js](https://nodejs.org/api/events.html) but for all platforms. |
 | `socket.io-parser`             | The parser responsible for encoding and decoding Socket.IO packets, used by both the `socket.io` and `socket.io-client` packages.     |
 

package-lock.json

@@ -4,7 +4,7 @@
     "packages/socket.io-component-emitter",
     "packages/engine.io-parser",
     "packages/engine.io",
-    "packages/socket.io-clustered-engine",
+    "packages/socket.io-cluster-engine",
     "packages/engine.io-client",
     "packages/socket.io-adapter",
     "packages/socket.io-parser",

package.json

@@ -0,0 +1,11 @@
+# History
+
+| Version                  | Release date |
+|--------------------------|--------------|
+| [0.1.0](#010-2024-07-17) | July 2024    |
+
+# Release notes
+
+## `0.1.0` (2024-07-17)
+
+Initial release!

packages/socket.io-cluster-engine/CHANGELOG.md

@@ -1,10 +1,11 @@
-# Socket.IO clustered engine
+# Socket.IO cluster engine
 
 A cluster-friendly engine to share load between multiple Node.js processes (without sticky sessions).
 
 **Table of contents**
 
 <!-- TOC -->
+  * [Installation](#installation)
   * [Usage](#usage)
     * [Node.js cluster](#nodejs-cluster)
     * [Redis](#redis)
@@ -14,6 +15,14 @@ A cluster-friendly engine to share load between multiple Node.js processes (with
   * [License](#license)
 <!-- TOC -->
 
+## Installation
+
+```
+npm i @socket.io/cluster-engine
+```
+
+NPM: https://npmjs.com/package/@socket.io/cluster-engine
+
 ## Usage
 
 ### Node.js cluster
@@ -22,7 +31,7 @@ A cluster-friendly engine to share load between multiple Node.js processes (with
 import cluster from "node:cluster";
 import process from "node:process";
 import { availableParallelism } from "node:os";
-import { setupPrimary, NodeClusterEngine } from "@socket.io/clustered-engine";
+import { setupPrimary, NodeClusterEngine } from "@socket.io/cluster-engine";
 import { createServer } from "node:http";
 import { Server } from "socket.io";
 
@@ -74,7 +83,7 @@ if (cluster.isPrimary) {
 ```js
 import { createServer } from "node:http";
 import { createClient } from "redis";
-import { RedisEngine } from "@socket.io/clustered-engine";
+import { RedisEngine } from "@socket.io/cluster-engine";
 import { Server } from "socket.io";
 
 const httpServer = createServer((req, res) => {
@@ -109,7 +118,7 @@ import cluster from "node:cluster";
 import process from "node:process";
 import { availableParallelism } from "node:os";
 import { createClient } from "redis";
-import { setupPrimaryWithRedis, NodeClusterEngine } from "@socket.io/clustered-engine";
+import { setupPrimaryWithRedis, NodeClusterEngine } from "@socket.io/cluster-engine";
 import { createServer } from "node:http";
 import { Server } from "socket.io";
 

packages/socket.io-clustered-engine/LICENSE packages/socket.io-cluster-engine/LICENSE

@@ -1,6 +1,6 @@
 {
-  "name": "@socket.io/clustered-engine",
-  "version": "0.0.1",
+  "name": "@socket.io/cluster-engine",
+  "version": "0.1.0",
   "description": "A cluster-friendly engine to share load between multiple Node.js processes (without sticky sessions)",
   "type": "commonjs",
   "license": "MIT",