@nestjs/websockets 12.0.0-alpha.2 → 12.0.0-alpha.4

package/Readme.md

@@ -29,7 +29,7 @@ Nest is a framework for building efficient, scalable <a href="https://nodejs.org
 
 ## Philosophy
 
-<p>In recent years, thanks to Node.js, JavaScript has become the “lingua franca” of the web for both front and backend applications, giving rise to awesome projects like <a href="https://angular.io/" target="_blank">Angular</a>, <a href="https://github.com/facebook/react" target="_blank">React</a>, and <a href="https://github.com/vuejs/vue" target="_blank">Vue</a>, which improve developer productivity and enable the construction of fast, testable, and extensible frontend applications. However, on the server-side, while there are a lot of superb libraries, helpers, and tools for Node, none of them effectively solve the main problem - the architecture.</p>
+<p>In recent years, thanks to Node.js, JavaScript has become the “lingua franca” of the web for both front-end and back-end applications, giving rise to awesome projects like <a href="https://angular.dev/" target="_blank">Angular</a>, <a href="https://react.dev/" target="_blank">React</a>, and <a href="https://vuejs.org/" target="_blank">Vue</a>, which improve developer productivity and enable the construction of fast, testable, and extensible frontend applications. However, on the server-side, while there are a lot of superb libraries, helpers, and tools for Node, none of them effectively solve the main problem - the architecture.</p>
 <p>Nest aims to provide an application architecture out of the box which allows for effortless creation of highly testable, scalable, and loosely coupled and easily maintainable applications. The architecture is heavily inspired by Angular.</p>
 
 ## Getting started
@@ -95,6 +95,7 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 <td align="center" valign="middle"><a href="https://crawljobs.com" target="_blank"><img src="https://nestjs.com/img/logos/crawljobs-logo.svg" width="130" valign="middle" /></a></td>
 </tr><tr>
 <td align="center" valign="middle"><a href="https://pandektes.com" target="_blank"><img src="https://nestjs.com/img/logos/pandektes-logo.png" width="65" valign="middle" /></a></td>
+<td align="center" valign="middle"><a href="https://www.fintechcrafts.com/" target="_blank"><img src="https://nestjs.com/img/logos/fintechcrafts-logo.svg" width="65" valign="middle" /></a></td>
 </tr>
 </table>
 

package/decorators/ws-pattern.decorator.d.ts

@@ -0,0 +1,16 @@
+import { PipeTransform, Type } from '@nestjs/common';
+/**
+ * WebSockets pattern parameter decorator.
+ * Extracts the subscribed message pattern from the current ws event.
+ *
+ * @example
+ * ```typescript
+ * @SubscribeMessage('events')
+ * onEvent(@WsPattern() pattern: string) {
+ *   return { event: pattern, data: 'ok' };
+ * }
+ * ```
+ *
+ * @publicApi
+ */
+export declare function WsPattern(...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;

package/decorators/ws-pattern.decorator.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WsPattern = WsPattern;
+const ws_paramtype_enum_1 = require("../enums/ws-paramtype.enum");
+const param_utils_1 = require("../utils/param.utils");
+/**
+ * WebSockets pattern parameter decorator.
+ * Extracts the subscribed message pattern from the current ws event.
+ *
+ * @example
+ * ```typescript
+ * @SubscribeMessage('events')
+ * onEvent(@WsPattern() pattern: string) {
+ *   return { event: pattern, data: 'ok' };
+ * }
+ * ```
+ *
+ * @publicApi
+ */
+function WsPattern(...pipes) {
+    return (0, param_utils_1.createPipesWsParamDecorator)(ws_paramtype_enum_1.WsParamtype.PATTERN)(undefined, ...pipes);
+}

package/exceptions/base-ws-exception-filter.d.ts

@@ -40,11 +40,33 @@ export declare class BaseWsExceptionFilter<TError = any> implements WsExceptionF
     constructor(options?: BaseWsExceptionFilterOptions);
     catch(exception: TError, host: ArgumentsHost): void;
     handleError<TClient extends {
-        emit: Function;
-    }>(client: TClient, exception: TError, cause: ErrorPayload['cause']): any;
+        emit?: Function;
+        send?: Function;
+    }>(client: TClient, exception: TError, cause: ErrorPayload['cause']): void;
     handleUnknownError<TClient extends {
-        emit: Function;
+        emit?: Function;
+        send?: Function;
     }>(exception: TError, client: TClient, data: ErrorPayload['cause']): void;
     isExceptionObject(err: any): err is Error;
+    /**
+     * Sends an error message to the client. Supports both Socket.IO clients
+     * (which use `emit`) and native WebSocket clients (which use `send`).
+     *
+     * Native WebSocket clients (e.g. from the `ws` package) inherit from
+     * EventEmitter and therefore also have an `emit` method, but that method
+     * only dispatches events locally. To distinguish native WebSocket clients
+     * from Socket.IO clients, we check for a numeric `readyState` property
+     * (part of the WebSocket specification) before falling back to `emit`.
+     */
+    protected emitMessage<TClient extends {
+        emit?: Function;
+        send?: Function;
+    }>(client: TClient, event: string, payload: unknown): void;
+    /**
+     * Determines whether the given client is a native WebSocket (e.g. from the
+     * `ws` package) as opposed to a Socket.IO socket. Native WebSocket objects
+     * expose a numeric `readyState` property per the WebSocket specification.
+     */
+    private isNativeWebSocket;
 }
 export {};

package/exceptions/base-ws-exception-filter.js

@@ -1,6 +1,6 @@
 import { IntrinsicException, Logger, } from '@nestjs/common';
 import { WsException } from '../errors/ws-exception.js';
-import { isObject } from '@nestjs/common/internal';
+import { isFunction, isNumber, isObject } from '@nestjs/common/internal';
 import { MESSAGES } from '@nestjs/core/internal';
 /**
  * @publicApi
@@ -30,7 +30,7 @@ export class BaseWsExceptionFilter {
         const status = 'error';
         const result = exception.getError();
         if (isObject(result)) {
-            return client.emit('exception', result);
+            return this.emitMessage(client, 'exception', result);
         }
         const payload = {
             status,
@@ -39,7 +39,7 @@ export class BaseWsExceptionFilter {
         if (this.options?.includeCause && cause) {
             payload.cause = this.options.causeFactory(cause.pattern, cause.data);
         }
-        client.emit('exception', payload);
+        this.emitMessage(client, 'exception', payload);
     }
     handleUnknownError(exception, client, data) {
         const status = 'error';
@@ -50,7 +50,7 @@ export class BaseWsExceptionFilter {
         if (this.options?.includeCause && data) {
             payload.cause = this.options.causeFactory(data.pattern, data.data);
         }
-        client.emit('exception', payload);
+        this.emitMessage(client, 'exception', payload);
         if (!(exception instanceof IntrinsicException)) {
             const logger = BaseWsExceptionFilter.logger;
             logger.error(exception);
@@ -59,4 +59,33 @@ export class BaseWsExceptionFilter {
     isExceptionObject(err) {
         return isObject(err) && !!err.message;
     }
+    /**
+     * Sends an error message to the client. Supports both Socket.IO clients
+     * (which use `emit`) and native WebSocket clients (which use `send`).
+     *
+     * Native WebSocket clients (e.g. from the `ws` package) inherit from
+     * EventEmitter and therefore also have an `emit` method, but that method
+     * only dispatches events locally. To distinguish native WebSocket clients
+     * from Socket.IO clients, we check for a numeric `readyState` property
+     * (part of the WebSocket specification) before falling back to `emit`.
+     */
+    emitMessage(client, event, payload) {
+        if (this.isNativeWebSocket(client)) {
+            client.send(JSON.stringify({
+                event,
+                data: payload,
+            }));
+        }
+        else if (isFunction(client.emit)) {
+            client.emit(event, payload);
+        }
+    }
+    /**
+     * Determines whether the given client is a native WebSocket (e.g. from the
+     * `ws` package) as opposed to a Socket.IO socket. Native WebSocket objects
+     * expose a numeric `readyState` property per the WebSocket specification.
+     */
+    isNativeWebSocket(client) {
+        return isNumber(client.readyState) && isFunction(client.send);
+    }
 }

package/exceptions/ws-exceptions-handler.js

@@ -8,7 +8,7 @@ export class WsExceptionsHandler extends BaseWsExceptionFilter {
     filters = [];
     handle(exception, host) {
         const client = host.switchToWs().getClient();
-        if (this.invokeCustomFilters(exception, host) || !client.emit) {
+        if (this.invokeCustomFilters(exception, host) || !client) {
             return;
         }
         super.catch(exception, host);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/websockets",
-  "version": "12.0.0-alpha.2",
+  "version": "12.0.0-alpha.4",
   "description": "Nest - modern, fast, powerful node.js web framework (@websockets)",
   "author": "Kamil Mysliwiec",
   "license": "MIT",
@@ -26,8 +26,8 @@
     "tslib": "2.8.1"
   },
   "devDependencies": {
-    "@nestjs/common": "^12.0.0-alpha.2",
-    "@nestjs/core": "^12.0.0-alpha.2"
+    "@nestjs/common": "^12.0.0-alpha.4",
+    "@nestjs/core": "^12.0.0-alpha.4"
   },
   "peerDependencies": {
     "@nestjs/common": "^11.0.0",
@@ -41,5 +41,5 @@
       "optional": true
     }
   },
-  "gitHead": "011bff66014e24e82b25f7acf9302b9efb70b02b"
+  "gitHead": "415e4d33707e74998d8456be7bd305cedb6508e3"
 }