@nestjs/platform-ws 10.4.10 → 11.0.0-next.1

package/adapters/ws-adapter.d.ts

@@ -4,6 +4,14 @@ import { MessageMappingProperties } from '@nestjs/websockets/gateway-metadata-ex
 import * as http from 'http';
 import { Observable } from 'rxjs';
 type WsServerRegistryEntry = any[];
+type WsData = string | Buffer | ArrayBuffer | Buffer[];
+type WsMessageParser = (data: WsData) => {
+    event: string;
+    data: any;
+} | void;
+type WsAdapterOptions = {
+    messageParser?: WsMessageParser;
+};
 /**
  * @publicApi
  */
@@ -11,7 +19,8 @@ export declare class WsAdapter extends AbstractWsAdapter {
     protected readonly logger: Logger;
     protected readonly httpServersRegistry: Map<number, any>;
     protected readonly wsServersRegistry: Map<number, WsServerRegistryEntry>;
-    constructor(appOrHttpServer?: INestApplicationContext | any);
+    protected messageParser: WsMessageParser;
+    constructor(appOrHttpServer?: INestApplicationContext | object, options?: WsAdapterOptions);
     create(port: number, options?: Record<string, any> & {
         namespace?: string;
         server?: any;
@@ -23,7 +32,8 @@ export declare class WsAdapter extends AbstractWsAdapter {
     bindClientDisconnect(client: any, callback: Function): void;
     close(server: any): Promise<void>;
     dispose(): Promise<void>;
-    protected ensureHttpServerExists(port: number, httpServer?: http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+    setMessageParser(parser: WsMessageParser): void;
+    protected ensureHttpServerExists(port: number, httpServer?: http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse> | undefined;
     protected addWsServerToRegistry<T extends Record<'path', string> = any>(wsServer: T, port: number, path: string): void;
 }
 export {};

package/adapters/ws-adapter.js

@@ -22,12 +22,18 @@ const UNDERLYING_HTTP_SERVER_PORT = 0;
  * @publicApi
  */
 class WsAdapter extends websockets_1.AbstractWsAdapter {
-    constructor(appOrHttpServer) {
+    constructor(appOrHttpServer, options) {
         super(appOrHttpServer);
         this.logger = new common_1.Logger(WsAdapter.name);
         this.httpServersRegistry = new Map();
         this.wsServersRegistry = new Map();
+        this.messageParser = (data) => {
+            return JSON.parse(data.toString());
+        };
         wsPackage = (0, load_package_util_1.loadPackage)('ws', 'WsAdapter', () => require('ws'));
+        if (options?.messageParser) {
+            this.messageParser = options.messageParser;
+        }
     }
     create(port, options) {
         const { server, path, ...wsOptions } = options;
@@ -83,7 +89,10 @@ class WsAdapter extends websockets_1.AbstractWsAdapter {
     }
     bindMessageHandler(buffer, handlersMap, transform) {
         try {
-            const message = JSON.parse(buffer.data);
+            const message = this.messageParser(buffer.data);
+            if (!message) {
+                return rxjs_1.EMPTY;
+            }
             const messageHandler = handlersMap.get(message.event);
             const { callback } = messageHandler;
             return transform(callback(message.data, message.event));
@@ -101,7 +110,7 @@ class WsAdapter extends websockets_1.AbstractWsAdapter {
         client.on(constants_1.CLOSE_EVENT, callback);
     }
     async close(server) {
-        const closeEventSignal = new Promise((resolve, reject) => server.close(err => (err ? reject(err) : resolve(undefined))));
+        const closeEventSignal = new Promise((resolve, reject) => server.close((err) => (err ? reject(err) : resolve(undefined))));
         for (const ws of server.clients) {
             ws.terminate();
         }
@@ -115,6 +124,9 @@ class WsAdapter extends websockets_1.AbstractWsAdapter {
         this.httpServersRegistry.clear();
         this.wsServersRegistry.clear();
     }
+    setMessageParser(parser) {
+        this.messageParser = parser;
+    }
     ensureHttpServerExists(port, httpServer = http.createServer()) {
         if (this.httpServersRegistry.has(port)) {
             return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/platform-ws",
-  "version": "10.4.10",
+  "version": "11.0.0-next.1",
   "description": "Nest - modern, fast, powerful node.js web framework (@platform-ws)",
   "author": "Kamil Mysliwiec",
   "license": "MIT",