@hazeljs/websocket 0.2.0-beta.1

package/dist/websocket.module.d.ts

@@ -0,0 +1,57 @@
+import { WebSocketServerOptions } from './websocket.types';
+import { SSEHandler } from './sse/sse.handler';
+import { RoomManager } from './room/room.manager';
+/**
+ * WebSocket module options
+ */
+export interface WebSocketModuleOptions extends WebSocketServerOptions {
+    /**
+     * Whether this is a global module
+     * @default true
+     */
+    isGlobal?: boolean;
+    /**
+     * Enable SSE support
+     * @default true
+     */
+    enableSSE?: boolean;
+    /**
+     * Enable room management
+     * @default true
+     */
+    enableRooms?: boolean;
+}
+/**
+ * WebSocket module for HazelJS
+ */
+export declare class WebSocketModule {
+    /**
+     * Configure WebSocket module
+     */
+    static forRoot(options?: WebSocketModuleOptions): {
+        module: typeof WebSocketModule;
+        providers: Array<{
+            provide: typeof SSEHandler | typeof RoomManager;
+            useValue: SSEHandler | RoomManager;
+        }>;
+        exports: Array<typeof SSEHandler | typeof RoomManager>;
+        global: boolean;
+    };
+    /**
+     * Configure WebSocket module asynchronously
+     */
+    static forRootAsync(options: {
+        useFactory: (...args: unknown[]) => Promise<WebSocketModuleOptions> | WebSocketModuleOptions;
+        inject?: unknown[];
+    }): {
+        module: typeof WebSocketModule;
+        providers: Array<{
+            provide: string | typeof SSEHandler | typeof RoomManager;
+            useFactory: unknown;
+            inject?: unknown[];
+        }>;
+        exports: Array<typeof SSEHandler | typeof RoomManager>;
+        global: boolean;
+    };
+}
+//# sourceMappingURL=websocket.module.d.ts.map

package/dist/websocket.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.module.d.ts","sourceRoot":"","sources":["../src/websocket.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGlD;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,sBAAsB;IACpE;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,qBAIa,eAAe;IAC1B;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,OAAO,GAAE,sBAA2B,GAAG;QACpD,MAAM,EAAE,OAAO,eAAe,CAAC;QAC/B,SAAS,EAAE,KAAK,CAAC;YACf,OAAO,EAAE,OAAO,UAAU,GAAG,OAAO,WAAW,CAAC;YAChD,QAAQ,EAAE,UAAU,GAAG,WAAW,CAAC;SACpC,CAAC,CAAC;QACH,OAAO,EAAE,KAAK,CAAC,OAAO,UAAU,GAAG,OAAO,WAAW,CAAC,CAAC;QACvD,MAAM,EAAE,OAAO,CAAC;KACjB;IAkCD;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE;QAC3B,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,sBAAsB,CAAC,GAAG,sBAAsB,CAAC;QAC7F,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;KACpB,GAAG;QACF,MAAM,EAAE,OAAO,eAAe,CAAC;QAC/B,SAAS,EAAE,KAAK,CAAC;YACf,OAAO,EAAE,MAAM,GAAG,OAAO,UAAU,GAAG,OAAO,WAAW,CAAC;YACzD,UAAU,EAAE,OAAO,CAAC;YACpB,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;SACpB,CAAC,CAAC;QACH,OAAO,EAAE,KAAK,CAAC,OAAO,UAAU,GAAG,OAAO,WAAW,CAAC,CAAC;QACvD,MAAM,EAAE,OAAO,CAAC;KACjB;CA4BF"}

package/dist/websocket.module.js

@@ -0,0 +1,88 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var WebSocketModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketModule = void 0;
+const core_1 = require("@hazeljs/core");
+const sse_handler_1 = require("./sse/sse.handler");
+const room_manager_1 = require("./room/room.manager");
+const core_2 = __importDefault(require("@hazeljs/core"));
+/**
+ * WebSocket module for HazelJS
+ */
+let WebSocketModule = WebSocketModule_1 = class WebSocketModule {
+    /**
+     * Configure WebSocket module
+     */
+    static forRoot(options = {}) {
+        const { isGlobal = true, enableSSE = true, enableRooms = true } = options;
+        core_2.default.info('Configuring WebSocket module...');
+        const providers = [];
+        // Add SSE handler if enabled
+        if (enableSSE) {
+            providers.push({
+                provide: sse_handler_1.SSEHandler,
+                useValue: new sse_handler_1.SSEHandler(),
+            });
+        }
+        // Add room manager if enabled
+        if (enableRooms) {
+            providers.push({
+                provide: room_manager_1.RoomManager,
+                useValue: new room_manager_1.RoomManager(),
+            });
+        }
+        return {
+            module: WebSocketModule_1,
+            providers,
+            exports: providers.map((p) => p.provide),
+            global: isGlobal,
+        };
+    }
+    /**
+     * Configure WebSocket module asynchronously
+     */
+    static forRootAsync(options) {
+        return {
+            module: WebSocketModule_1,
+            providers: [
+                {
+                    provide: 'WEBSOCKET_OPTIONS',
+                    useFactory: options.useFactory,
+                    inject: options.inject || [],
+                },
+                {
+                    provide: sse_handler_1.SSEHandler,
+                    useFactory: (wsOptions) => {
+                        return wsOptions.enableSSE !== false ? new sse_handler_1.SSEHandler() : null;
+                    },
+                    inject: ['WEBSOCKET_OPTIONS'],
+                },
+                {
+                    provide: room_manager_1.RoomManager,
+                    useFactory: (wsOptions) => {
+                        return wsOptions.enableRooms !== false ? new room_manager_1.RoomManager() : null;
+                    },
+                    inject: ['WEBSOCKET_OPTIONS'],
+                },
+            ],
+            exports: [sse_handler_1.SSEHandler, room_manager_1.RoomManager],
+            global: true,
+        };
+    }
+};
+exports.WebSocketModule = WebSocketModule;
+exports.WebSocketModule = WebSocketModule = WebSocketModule_1 = __decorate([
+    (0, core_1.HazelModule)({
+        providers: [],
+        exports: [],
+    })
+], WebSocketModule);

package/dist/websocket.types.d.ts

@@ -0,0 +1,258 @@
+import { IncomingMessage } from 'http';
+/**
+ * WebSocket client interface
+ */
+export interface WebSocketClient {
+    /**
+     * Unique client ID
+     */
+    id: string;
+    /**
+     * Client socket
+     */
+    socket: unknown;
+    /**
+     * Client metadata
+     */
+    metadata: Map<string, unknown>;
+    /**
+     * Rooms the client is in
+     */
+    rooms: Set<string>;
+    /**
+     * Send message to client
+     */
+    send(event: string, data: unknown): void;
+    /**
+     * Disconnect client
+     */
+    disconnect(): void;
+    /**
+     * Join a room
+     */
+    join(room: string): void;
+    /**
+     * Leave a room
+     */
+    leave(room: string): void;
+    /**
+     * Check if client is in a room
+     */
+    inRoom(room: string): boolean;
+}
+/**
+ * WebSocket message
+ */
+export interface WebSocketMessage {
+    /**
+     * Event name
+     */
+    event: string;
+    /**
+     * Message data
+     */
+    data: unknown;
+    /**
+     * Timestamp
+     */
+    timestamp: number;
+    /**
+     * Client ID
+     */
+    clientId?: string;
+}
+/**
+ * WebSocket gateway options
+ */
+export interface WebSocketGatewayOptions {
+    /**
+     * Gateway path
+     */
+    path?: string;
+    /**
+     * Namespace
+     */
+    namespace?: string;
+    /**
+     * CORS options
+     */
+    cors?: {
+        origin?: string | string[];
+        credentials?: boolean;
+    };
+    /**
+     * Authentication required
+     */
+    auth?: boolean;
+    /**
+     * Ping interval in milliseconds
+     */
+    pingInterval?: number;
+    /**
+     * Ping timeout in milliseconds
+     */
+    pingTimeout?: number;
+    /**
+     * Maximum payload size in bytes
+     */
+    maxPayload?: number;
+}
+/**
+ * Room interface
+ */
+export interface Room {
+    /**
+     * Room name
+     */
+    name: string;
+    /**
+     * Clients in the room
+     */
+    clients: Set<string>;
+    /**
+     * Room metadata
+     */
+    metadata: Map<string, unknown>;
+    /**
+     * Created timestamp
+     */
+    createdAt: number;
+}
+/**
+ * WebSocket event handler
+ */
+export type WebSocketEventHandler = (client: WebSocketClient, data: unknown) => void | Promise<void>;
+/**
+ * Connection handler
+ */
+export type ConnectionHandler = (client: WebSocketClient, request: IncomingMessage) => void | Promise<void>;
+/**
+ * Disconnection handler
+ */
+export type DisconnectionHandler = (client: WebSocketClient, reason?: string) => void | Promise<void>;
+/**
+ * WebSocket server options
+ */
+export interface WebSocketServerOptions {
+    /**
+     * Port to listen on
+     */
+    port?: number;
+    /**
+     * Host to bind to
+     */
+    host?: string;
+    /**
+     * Path for WebSocket endpoint
+     */
+    path?: string;
+    /**
+     * Enable per-message deflate
+     */
+    perMessageDeflate?: boolean;
+    /**
+     * Maximum payload size
+     */
+    maxPayload?: number;
+    /**
+     * Client tracking
+     */
+    clientTracking?: boolean;
+}
+/**
+ * SSE (Server-Sent Events) options
+ */
+export interface SSEOptions {
+    /**
+     * Retry interval in milliseconds
+     */
+    retry?: number;
+    /**
+     * Keep-alive interval in milliseconds
+     */
+    keepAlive?: number;
+    /**
+     * Event ID
+     */
+    id?: string;
+}
+/**
+ * SSE message
+ */
+export interface SSEMessage {
+    /**
+     * Event type
+     */
+    event?: string;
+    /**
+     * Message data
+     */
+    data: unknown;
+    /**
+     * Event ID
+     */
+    id?: string;
+    /**
+     * Retry interval
+     */
+    retry?: number;
+}
+/**
+ * Subscription options
+ */
+export interface SubscriptionOptions {
+    /**
+     * Topic pattern
+     */
+    topic: string;
+    /**
+     * Filter function
+     */
+    filter?: (data: unknown) => boolean;
+    /**
+     * Transform function
+     */
+    transform?: (data: unknown) => unknown;
+    /**
+     * Batch size
+     */
+    batchSize?: number;
+    /**
+     * Batch interval in milliseconds
+     */
+    batchInterval?: number;
+}
+/**
+ * WebSocket statistics
+ */
+export interface WebSocketStats {
+    /**
+     * Total connected clients
+     */
+    connectedClients: number;
+    /**
+     * Total rooms
+     */
+    totalRooms: number;
+    /**
+     * Messages sent
+     */
+    messagesSent: number;
+    /**
+     * Messages received
+     */
+    messagesReceived: number;
+    /**
+     * Bytes sent
+     */
+    bytesSent: number;
+    /**
+     * Bytes received
+     */
+    bytesReceived: number;
+    /**
+     * Uptime in milliseconds
+     */
+    uptime: number;
+}
+//# sourceMappingURL=websocket.types.d.ts.map

package/dist/websocket.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.types.d.ts","sourceRoot":"","sources":["../src/websocket.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE;QACL,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;IAEF;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAClC,MAAM,EAAE,eAAe,EACvB,IAAI,EAAE,OAAO,KACV,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAC9B,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,eAAe,KACrB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,MAAM,EAAE,eAAe,EACvB,MAAM,CAAC,EAAE,MAAM,KACZ,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC;IAEvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB"}

package/dist/websocket.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@hazeljs/websocket",
+  "version": "0.2.0-beta.1",
+  "description": "WebSocket and Server-Sent Events module for HazelJS framework",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "jest --coverage --maxWorkers=1 --detectOpenHandles=false",
+    "lint": "eslint \"src/**/*.ts\"",
+    "lint:fix": "eslint \"src/**/*.ts\" --fix",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "@hazeljs/core": "file:../core",
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.17.50",
+    "@types/ws": "^8.5.13",
+    "@typescript-eslint/eslint-plugin": "^8.18.2",
+    "@typescript-eslint/parser": "^8.18.2",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.3.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hazel-js/hazeljs.git",
+    "directory": "packages/websocket"
+  },
+  "keywords": [
+    "hazeljs",
+    "websocket",
+    "sse",
+    "realtime",
+    "socket"
+  ],
+  "author": "Muhammad Arslan <marslan@hazeljs.com>",
+  "license": "MIT"
+}