@nestjs/websockets 11.1.6 → 11.1.7

package/Readme.md

@@ -8,7 +8,7 @@
   <p align="center">A progressive <a href="https://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
     <p align="center">
 <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
+<a href="https://github.com/nestjs/nest/blob/master/LICENSE" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
 <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
 <a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
 <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
@@ -78,10 +78,7 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 </tr>
 <tr>
 <td><a href="https://snyk.co/nestjs" target="_blank"><img src="https://nestjs.com/img/logos/snyk-logo-black.png" width="185" valign="middle" /></a></td>
-<td><a href="https://fuseautotech.com/" target="_blank"><img src="https://nestjs.com/img/logos/fuse-logo.svg" width="105" valign="middle" /></a></td>
-<td><a href="https://ridicorp.com/career/" target="_blank"><img src="https://nestjs.com/img/logos/ridi-logo.svg" width="105" valign="middle" /></a></td>
 <td><a href="https://www.movavi.com/imovie-for-windows.html" target="_blank"><img src="https://nestjs.com/img/logos/movavi-logo.svg" width="105" valign="middle" /></a></td>
-<td><a href="https://skunk.team" target="_blank"><img src="https://nestjs.com/img/logos/skunk-logo.png" height="60" valign="middle" /></a></td>
 </tr>
 </table>
 
@@ -91,10 +88,10 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 <tr>
 <td><a href="https://www.mercedes-benz.com/" target="_blank"><img src="https://nestjs.com/img/logos/mercedes-logo.png" width="100" valign="middle" /></a></td>
 <td><a href="https://www.dinii.jp/" target="_blank"><img src="https://nestjs.com/img/logos/dinii-logo.png" width="65" valign="middle" /></a></td>
-<td><a href="https://bloodycase.com/?promocode=NEST" target="_blank"><img src="https://nestjs.com/img/logos/bloodycase-logo.png" width="65" valign="middle" /></a></td>
 <td><a href="https://handsontable.com/docs/react-data-grid/?utm_source=NestJS_GH&utm_medium=sponsorship&utm_campaign=library_sponsorship_2024" target="_blank"><img src="https://nestjs.com/img/logos/handsontable-dark-logo.svg#2" width="150" valign="middle" /></a></td>
 <td align="center" valign="middle"><a href="https://www.itflashcards.com/" target="_blank"><img src="https://nestjs.com/img/logos/it_flashcards-logo.png" width="170" valign="middle" /></a></td>
 <td align="center" valign="middle"><a href="https://arcjet.com/?ref=nestjs" target="_blank"><img src="https://nestjs.com/img/logos/arcjet-logo.svg" width="170" valign="middle" /></a></td>
+<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>
 </table>
 
@@ -118,19 +115,16 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 <td align="center" valign="middle"><a href="https://triplecore.io" target="_blank"><img src="https://nestjs.com/img/logos/triplecore-logo.svg" width="50" valign="middle" /></a></td>
 </tr>
 <tr>
-<td align="center" valign="middle"><a href="https://thecasinowizard.com/bonuses/no-deposit-bonuses/" target="_blank"><img src="https://nestjs.com/img/logos/casinowizard-logo.png" width="120" valign="middle" /></a></td>
 <td align="center" valign="middle"><a href="https://polygon-software.ch/" target="_blank"><img src="https://nestjs.com/img/logos/polygon-logo.svg" width="120" valign="middle" /></a></td>
 <td align="center" valign="middle"><a href="https://boringowl.io/" target="_blank"><img src="https://nestjs.com/img/logos/boringowl-logo.svg" width="120" valign="middle" /></a></td>
 <td align="center" valign="middle"><a href="https://nordbot.app/" target="_blank"><img src="https://nestjs.com/img/logos/nordbot-logo.png" width="120" valign="middle" /></a></td>
 <td align="center" valign="middle"><a href="https://doppio.sh/" target="_blank"><img src="https://nestjs.com/img/logos/dopiosh-logo.png" width="50" valign="middle" /></a></td>
 <td align="center" valign="middle"><a href="https://www.hingehealth.com/" target="_blank"><img src="https://nestjs.com/img/logos/hinge-health-logo.svg" width="100" valign="middle" /></a></td>
+<td align="center" valign="middle"><a href="https://www.tripoffice.com/" target="_blank"><img src="https://nestjs.com/img/logos/tripoffice-logo.png" width="140" valign="middle" /></a></td>
 </tr>
 <tr>
-<td align="center" valign="middle"><a href="https://julienferand.dev/" target="_blank"><img src="https://nestjs.com/img/logos/julienferand-logo.jpeg" width="55" valign="middle" /></a></td>
-<td align="center" valign="middle"><a href="https://www.tripoffice.com/" target="_blank"><img src="https://nestjs.com/img/logos/tripoffice-logo.png" width="140" valign="middle" /></a></td>
 <td align="center" valign="middle"><a href="https://solcellsforetag.se/" target="_blank"><img src="https://nestjs.com/img/logos/solcellsforetag-logo.svg" width="140" valign="middle" /></a></td>
 <td align="center" valign="middle"><a href="https://www.route4me.com/" target="_blank"><img src="https://nestjs.com/img/logos/route4me-logo.svg" width="100" valign="middle" /></a></td>
-<td align="center" valign="middle"><a href="https://www.slotsup.com/" target="_blank"><img src="https://nestjs.com/img/logos/slotsup-logo.png" width="60" valign="middle" /></a></td>
 </tr>
 </table>
 

package/context/ws-metadata-constants.d.ts

@@ -1,4 +1,9 @@
 export declare const DEFAULT_CALLBACK_METADATA: {
+    "13:2": {
+        index: number;
+        data: undefined;
+        pipes: never[];
+    };
     "3:1": {
         index: number;
         data: undefined;

package/context/ws-metadata-constants.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_CALLBACK_METADATA = void 0;
 const ws_paramtype_enum_1 = require("../enums/ws-paramtype.enum");
 exports.DEFAULT_CALLBACK_METADATA = {
+    [`${ws_paramtype_enum_1.WsParamtype.ACK}:2`]: { index: 2, data: undefined, pipes: [] },
     [`${ws_paramtype_enum_1.WsParamtype.PAYLOAD}:1`]: { index: 1, data: undefined, pipes: [] },
     [`${ws_paramtype_enum_1.WsParamtype.SOCKET}:0`]: { index: 0, data: undefined, pipes: [] },
 };

package/decorators/ack.decorator.d.ts

@@ -0,0 +1,23 @@
+/**
+ * WebSockets `ack` parameter decorator.
+ * Extracts the `ack` callback function from the arguments of a ws event.
+ *
+ * This decorator signals to the framework that the `ack` callback will be
+ * handled manually within the method, preventing the framework from
+ * automatically sending an acknowledgement based on the return value.
+ *
+ * @example
+ * ```typescript
+ * @SubscribeMessage('events')
+ * onEvent(
+ *   @MessageBody() data: string,
+ *   @Ack() ack: (response: any) => void
+ * ) {
+ *   // Manually call the ack callback
+ *   ack({ status: 'ok' });
+ * }
+ * ```
+ *
+ * @publicApi
+ */
+export declare function Ack(): ParameterDecorator;

package/decorators/ack.decorator.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Ack = Ack;
+const ws_paramtype_enum_1 = require("../enums/ws-paramtype.enum");
+const param_utils_1 = require("../utils/param.utils");
+/**
+ * WebSockets `ack` parameter decorator.
+ * Extracts the `ack` callback function from the arguments of a ws event.
+ *
+ * This decorator signals to the framework that the `ack` callback will be
+ * handled manually within the method, preventing the framework from
+ * automatically sending an acknowledgement based on the return value.
+ *
+ * @example
+ * ```typescript
+ * @SubscribeMessage('events')
+ * onEvent(
+ *   @MessageBody() data: string,
+ *   @Ack() ack: (response: any) => void
+ * ) {
+ *   // Manually call the ack callback
+ *   ack({ status: 'ok' });
+ * }
+ * ```
+ *
+ * @publicApi
+ */
+function Ack() {
+    return (0, param_utils_1.createPipesWsParamDecorator)(ws_paramtype_enum_1.WsParamtype.ACK)();
+}

package/decorators/index.d.ts

@@ -3,3 +3,4 @@ export * from './gateway-server.decorator';
 export * from './message-body.decorator';
 export * from './socket-gateway.decorator';
 export * from './subscribe-message.decorator';
+export * from './ack.decorator';

package/decorators/index.js

@@ -6,3 +6,4 @@ tslib_1.__exportStar(require("./gateway-server.decorator"), exports);
 tslib_1.__exportStar(require("./message-body.decorator"), exports);
 tslib_1.__exportStar(require("./socket-gateway.decorator"), exports);
 tslib_1.__exportStar(require("./subscribe-message.decorator"), exports);
+tslib_1.__exportStar(require("./ack.decorator"), exports);

package/enums/ws-paramtype.enum.d.ts

@@ -1,4 +1,5 @@
 export declare enum WsParamtype {
     SOCKET = 0,
-    PAYLOAD = 3
+    PAYLOAD = 3,
+    ACK = 13
 }

package/enums/ws-paramtype.enum.js

@@ -5,4 +5,5 @@ var WsParamtype;
 (function (WsParamtype) {
     WsParamtype[WsParamtype["SOCKET"] = 0] = "SOCKET";
     WsParamtype[WsParamtype["PAYLOAD"] = 3] = "PAYLOAD";
+    WsParamtype[WsParamtype["ACK"] = 13] = "ACK";
 })(WsParamtype || (exports.WsParamtype = WsParamtype = {}));

package/factories/ws-params-factory.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WsParamsFactory = void 0;
+const shared_utils_1 = require("@nestjs/common/utils/shared.utils");
 const ws_paramtype_enum_1 = require("../enums/ws-paramtype.enum");
 class WsParamsFactory {
     exchangeKeyForValue(type, data, args) {
@@ -12,6 +13,9 @@ class WsParamsFactory {
                 return args[0];
             case ws_paramtype_enum_1.WsParamtype.PAYLOAD:
                 return data ? args[1]?.[data] : args[1];
+            case ws_paramtype_enum_1.WsParamtype.ACK: {
+                return args.find(arg => (0, shared_utils_1.isFunction)(arg));
+            }
             default:
                 return null;
         }

package/gateway-metadata-explorer.d.ts

@@ -5,11 +5,14 @@ export interface MessageMappingProperties {
     message: any;
     methodName: string;
     callback: (...args: any[]) => Observable<any> | Promise<any>;
+    isAckHandledManually: boolean;
 }
 export declare class GatewayMetadataExplorer {
     private readonly metadataScanner;
+    private readonly contextUtils;
     constructor(metadataScanner: MetadataScanner);
     explore(instance: NestGateway): MessageMappingProperties[];
     exploreMethodMetadata(instancePrototype: object, methodName: string): MessageMappingProperties | null;
+    private hasAckDecorator;
     scanForServerHooks(instance: NestGateway): IterableIterator<string>;
 }

package/gateway-metadata-explorer.js

@@ -3,9 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GatewayMetadataExplorer = void 0;
 const shared_utils_1 = require("@nestjs/common/utils/shared.utils");
 const constants_1 = require("./constants");
+const ws_paramtype_enum_1 = require("./enums/ws-paramtype.enum");
+const context_utils_1 = require("@nestjs/core/helpers/context-utils");
 class GatewayMetadataExplorer {
     constructor(metadataScanner) {
         this.metadataScanner = metadataScanner;
+        this.contextUtils = new context_utils_1.ContextUtils();
     }
     explore(instance) {
         const instancePrototype = Object.getPrototypeOf(instance);
@@ -21,12 +24,25 @@ class GatewayMetadataExplorer {
             return null;
         }
         const message = Reflect.getMetadata(constants_1.MESSAGE_METADATA, callback);
+        const isAckHandledManually = this.hasAckDecorator(instancePrototype, methodName);
         return {
             callback,
             message,
             methodName,
+            isAckHandledManually,
         };
     }
+    hasAckDecorator(instancePrototype, methodName) {
+        const paramsMetadata = Reflect.getMetadata(constants_1.PARAM_ARGS_METADATA, instancePrototype.constructor, methodName);
+        if (!paramsMetadata) {
+            return false;
+        }
+        const metadataKeys = Object.keys(paramsMetadata);
+        return metadataKeys.some(key => {
+            const type = this.contextUtils.mapParamType(key);
+            return Number(type) === ws_paramtype_enum_1.WsParamtype.ACK;
+        });
+    }
     *scanForServerHooks(instance) {
         for (const propertyKey in instance) {
             if ((0, shared_utils_1.isFunction)(propertyKey)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/websockets",
-  "version": "11.1.6",
+  "version": "11.1.7",
   "description": "Nest - modern, fast, powerful node.js web framework (@websockets)",
   "author": "Kamil Mysliwiec",
   "license": "MIT",
@@ -18,8 +18,8 @@
     "tslib": "2.8.1"
   },
   "devDependencies": {
-    "@nestjs/common": "11.1.6",
-    "@nestjs/core": "11.1.6"
+    "@nestjs/common": "11.1.7",
+    "@nestjs/core": "11.1.7"
   },
   "peerDependencies": {
     "@nestjs/common": "^11.0.0",

package/web-sockets-controller.js

@@ -31,10 +31,11 @@ class WebSocketsController {
     }
     subscribeToServerEvents(instance, options, port, moduleKey, instanceWrapperId) {
         const nativeMessageHandlers = this.metadataExplorer.explore(instance);
-        const messageHandlers = nativeMessageHandlers.map(({ callback, message, methodName }) => ({
+        const messageHandlers = nativeMessageHandlers.map(({ callback, isAckHandledManually, message, methodName }) => ({
             message,
             methodName,
             callback: this.contextCreator.create(instance, callback, moduleKey, methodName),
+            isAckHandledManually,
         }));
         this.inspectEntrypointDefinitions(instance, port, messageHandlers, instanceWrapperId);
         if (this.appOptions.preview) {
@@ -86,9 +87,10 @@ class WebSocketsController {
     }
     subscribeMessages(subscribersMap, client, instance) {
         const adapter = this.config.getIoAdapter();
-        const handlers = subscribersMap.map(({ callback, message }) => ({
+        const handlers = subscribersMap.map(({ callback, message, isAckHandledManually }) => ({
             message,
             callback: callback.bind(instance, client),
+            isAckHandledManually,
         }));
         adapter.bindMessageHandlers(client, handlers, data => (0, rxjs_1.from)(this.pickResult(data)).pipe((0, operators_1.mergeAll)()));
     }