@designofadecade/server 4.0.0

package/dist/websocket/WebSocketServer.js

@@ -0,0 +1,138 @@
+import { EventEmitter } from 'events';
+import { WebSocketServer as WebSocketServerLibrary, WebSocket } from 'ws';
+import { logger } from '../logger/Logger.js';
+import WebSocketMessageFormatter from './WebSocketMessageFormatter.js';
+export default class WebSocketServer extends EventEmitter {
+    #wss;
+    constructor({ port = 8080, host = '0.0.0.0' } = {}) {
+        super();
+        // Validate port
+        if (isNaN(port) || port < 1 || port > 65535) {
+            throw new Error(`Port ${port} is invalid. Must be between 1 and 65535.`);
+        }
+        this.#init(port, host);
+    }
+    get clientCount() {
+        return this.#wss.clients.size;
+    }
+    #init(port, host) {
+        this.#wss = new WebSocketServerLibrary({ port, host });
+        // Error handler for the WebSocket server itself
+        this.#wss.on('error', (error) => {
+            if (error.code === 'EADDRINUSE') {
+                logger.error('WebSocket port is already in use', {
+                    code: 'WEBSOCKET_PORT_IN_USE',
+                    source: 'WebSocketServer.init',
+                    port,
+                    error,
+                });
+                process.exit(1);
+            }
+            logger.error('WebSocket Server error', {
+                code: 'WEBSOCKET_SERVER_ERROR',
+                source: 'WebSocketServer.init',
+                error,
+                errorCode: error.code,
+            });
+            process.exit(1);
+        });
+        this.#wss.on('listening', () => {
+            logger.info('WebSocket Server listening', {
+                source: 'WebSocketServer.init',
+                host,
+                port,
+            });
+        });
+        this.#wss.on('connection', (ws) => {
+            logger.info('WebSocket client connected', {
+                source: 'WebSocketServer.connection',
+                clientCount: this.clientCount,
+            });
+            ws.send(WebSocketMessageFormatter.format('ws:connected', {
+                message: 'WebSocket connection established',
+            }));
+            ws.on('message', async (message) => {
+                const messageString = message.toString();
+                if (messageString.includes('ws:ping')) {
+                    ws.send(WebSocketMessageFormatter.format('ws:pong', {}));
+                    return;
+                }
+                try {
+                    const parsed = WebSocketMessageFormatter.parse(messageString);
+                    if (!parsed) {
+                        ws.send(WebSocketMessageFormatter.format('ws:error', {
+                            error: 'Invalid message format',
+                        }));
+                        return;
+                    }
+                    this.emit('message', parsed);
+                }
+                catch (error) {
+                    logger.error('Message handling error', {
+                        code: 'WEBSOCKET_MESSAGE_ERROR',
+                        source: 'WebSocketServer.onMessage',
+                        error,
+                    });
+                    ws.send(WebSocketMessageFormatter.format('ws:error', {
+                        error: error.message,
+                    }));
+                }
+            });
+            ws.on('close', () => {
+                logger.info('WebSocket client disconnected', {
+                    source: 'WebSocketServer.onClose',
+                    clientCount: this.clientCount,
+                });
+            });
+            ws.on('error', (error) => {
+                logger.error('WebSocket error', {
+                    code: 'WEBSOCKET_CLIENT_ERROR',
+                    source: 'WebSocketServer.onError',
+                    error,
+                });
+            });
+        });
+    }
+    broadcast(message) {
+        this.#wss.clients.forEach((client) => {
+            if (client.readyState === WebSocket.OPEN) {
+                try {
+                    client.send(message);
+                }
+                catch (error) {
+                    logger.error('Broadcast send error', {
+                        code: 'WEBSOCKET_BROADCAST_ERROR',
+                        source: 'WebSocketServer.broadcast',
+                        error,
+                    });
+                }
+            }
+        });
+    }
+    close() {
+        return new Promise((resolve, reject) => {
+            if (this.#wss) {
+                this.#wss.close((error) => {
+                    if (error) {
+                        logger.error('Error closing WebSocket Server', {
+                            code: 'WEBSOCKET_CLOSE_ERROR',
+                            source: 'WebSocketServer.close',
+                            error,
+                        });
+                        reject(error);
+                    }
+                    else {
+                        logger.info('WebSocket Server closed', {
+                            source: 'WebSocketServer.close',
+                        });
+                        resolve();
+                    }
+                });
+            }
+            else {
+                resolve();
+            }
+        });
+    }
+}
+//# sourceMappingURL=WebSocketServer.js.map

package/dist/websocket/WebSocketServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocketServer.js","sourceRoot":"","sources":["../../src/websocket/WebSocketServer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,eAAe,IAAI,sBAAsB,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAC1E,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,yBAAyB,MAAM,gCAAgC,CAAC;AAOvE,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,YAAY;IACvD,IAAI,CAA0B;IAE9B,YAAY,EAAE,IAAI,GAAG,IAAI,EAAE,IAAI,GAAG,SAAS,KAA6B,EAAE;QACxE,KAAK,EAAE,CAAC;QAER,gBAAgB;QAChB,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,KAAK,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,2CAA2C,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,IAAY,EAAE,IAAY;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,sBAAsB,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAEvD,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAA4B,EAAE,EAAE;YACrD,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBAChC,MAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE;oBAC/C,IAAI,EAAE,uBAAuB;oBAC7B,MAAM,EAAE,sBAAsB;oBAC9B,IAAI;oBACJ,KAAK;iBACN,CAAC,CAAC;gBACH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;YACD,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE;gBACrC,IAAI,EAAE,wBAAwB;gBAC9B,MAAM,EAAE,sBAAsB;gBAC9B,KAAK;gBACL,SAAS,EAAE,KAAK,CAAC,IAAI;aACtB,CAAC,CAAC;YACH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YAC7B,MAAM,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACxC,MAAM,EAAE,sBAAsB;gBAC9B,IAAI;gBACJ,IAAI;aACL,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,EAAa,EAAE,EAAE;YAC3C,MAAM,CAAC,IAAI,CAAC,4BAA4B,EAAE;gBACxC,MAAM,EAAE,4BAA4B;gBACpC,WAAW,EAAE,IAAI,CAAC,WAAW;aAC9B,CAAC,CAAC;YAEH,EAAE,CAAC,IAAI,CACL,yBAAyB,CAAC,MAAM,CAAC,cAAc,EAAE;gBAC/C,OAAO,EAAE,kCAAkC;aAC5C,CAAC,CACH,CAAC;YAEF,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,OAAe,EAAE,EAAE;gBACzC,MAAM,aAAa,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;gBAEzC,IAAI,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;oBACtC,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;oBACzD,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,yBAAyB,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;oBAE9D,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,EAAE,CAAC,IAAI,CACL,yBAAyB,CAAC,MAAM,CAAC,UAAU,EAAE;4BAC3C,KAAK,EAAE,wBAAwB;yBAChC,CAAC,CACH,CAAC;wBACF,OAAO;oBACT,CAAC;oBAED,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;gBAC/B,CAAC;gBAAC,OAAO,KAAU,EAAE,CAAC;oBACpB,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE;wBACrC,IAAI,EAAE,yBAAyB;wBAC/B,MAAM,EAAE,2BAA2B;wBACnC,KAAK;qBACN,CAAC,CAAC;oBACH,EAAE,CAAC,IAAI,CACL,yBAAyB,CAAC,MAAM,CAAC,UAAU,EAAE;wBAC3C,KAAK,EAAE,KAAK,CAAC,OAAO;qBACrB,CAAC,CACH,CAAC;gBACJ,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBAClB,MAAM,CAAC,IAAI,CAAC,+BAA+B,EAAE;oBAC3C,MAAM,EAAE,yBAAyB;oBACjC,WAAW,EAAE,IAAI,CAAC,WAAW;iBAC9B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE;gBAC9B,MAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE;oBAC9B,IAAI,EAAE,wBAAwB;oBAC9B,MAAM,EAAE,yBAAyB;oBACjC,KAAK;iBACN,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,SAAS,CAAC,OAAe;QACvB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACnC,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;gBACzC,IAAI,CAAC;oBACH,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvB,CAAC;gBAAC,OAAO,KAAU,EAAE,CAAC;oBACpB,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE;wBACnC,IAAI,EAAE,2BAA2B;wBACjC,MAAM,EAAE,2BAA2B;wBACnC,KAAK;qBACN,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK;QACH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAa,EAAE,EAAE;oBAChC,IAAI,KAAK,EAAE,CAAC;wBACV,MAAM,CAAC,KAAK,CAAC,gCAAgC,EAAE;4BAC7C,IAAI,EAAE,uBAAuB;4BAC7B,MAAM,EAAE,uBAAuB;4BAC/B,KAAK;yBACN,CAAC,CAAC;wBACH,MAAM,CAAC,KAAK,CAAC,CAAC;oBAChB,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,IAAI,CAAC,yBAAyB,EAAE;4BACrC,MAAM,EAAE,uBAAuB;yBAChC,CAAC,CAAC;wBACH,OAAO,EAAE,CAAC;oBACZ,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@designofadecade/server",
+  "version": "4.0.0",
+  "description": "Design of a Decade Server - A modern TypeScript server with WebSocket support",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui",
+    "bench": "vitest bench",
+    "bench:watch": "vitest bench --watch",
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "clean": "rm -rf dist",
+    "prepare": "husky",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint src/**/*.ts",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "typecheck": "tsc --noEmit"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "keywords": [
+    "server",
+    "websocket",
+    "typescript",
+    "node",
+    "api",
+    "http-server",
+    "router",
+    "middleware",
+    "framework",
+    "esm",
+    "websocket-server",
+    "routing",
+    "static-files",
+    "html-sanitizer",
+    "event-emitter",
+    "state-management",
+    "openapi",
+    "swagger",
+    "rest-api"
+  ],
+  "author": "Design of a Decade <info@designofadecade.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/designofadecade/server#readme",
+  "bugs": {
+    "url": "https://github.com/designofadecade/server/issues"
+  },
+  "dependencies": {
+    "ws": "^8.16.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "@types/ws": "^8.5.10",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "@vitest/coverage-v8": "^2.0.0",
+    "@vitest/ui": "^2.0.0",
+    "eslint": "^8.57.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.2.5",
+    "typescript": "^5.3.0",
+    "vitest": "^2.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/designofadecade/server.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "lint-staged": {
+    "*.ts": [
+      "prettier --write",
+      "eslint --fix",
+      "vitest related --run"
+    ]
+  }
+}