nestjs-wsgate 0.0.1

package/LICENSE

@@ -0,0 +1 @@
+MIT License

package/README.md

@@ -0,0 +1 @@
+[Read Readme on github](https://github.com/shaishab316/nestjs-wsgate)

package/dist/decorators/ws-doc.decorator.d.ts

@@ -0,0 +1,66 @@
+/**
+ * nestjs-wsgate
+ *
+ * Copyright (c) 2026 Shaishab Chandra Shil (@shaishab316)
+ * MIT License — https://opensource.org/licenses/MIT
+ *
+ * @packageDocumentation
+ */
+/**
+ * A unique metadata key for storing WebSocket event documentation
+ * on handler methods via `@WsDoc()`.
+ *
+ * @internal Do not change — this key is used internally by `WsgateExplorer`.
+ */
+export declare const WSGATE_EVENT_METADATA = "wsgate:event_doc";
+/**
+ * Options for the `@WsDoc()` decorator.
+ * Describes a WebSocket gateway event for the nestjs-wsgate UI.
+ */
+export interface WsDocOptions {
+    /** The name of the Socket.IO event this handler listens to (client → server). */
+    event: string;
+    /** A short human-readable description of what this event does. */
+    description?: string;
+    /**
+     * The expected payload shape for this event.
+     * Keys are field names, values are their types (e.g. `{ roomId: 'string' }`).
+     *
+     * Supports:
+     * - Primitives: `'string'`, `'number'`, `'boolean'`
+     * - Enums: `'info | warn | error'` (pipe-separated)
+     */
+    payload?: Record<string, string>;
+    /** The Socket.IO event name emitted back to the client (server → client). */
+    response?: string;
+    /**
+     * Whether this event is emitted by the client or received from the server.
+     * - `emit`      — client sends this event to the server (default)
+     * - `subscribe` — server sends this event to the client
+     *
+     * @default 'emit'
+     */
+    type?: "emit" | "subscribe";
+}
+/**
+ * Marks a WebSocket gateway method as a documented event.
+ * Metadata is collected at bootstrap by `WsgateExplorer` and
+ * served via the nestjs-wsgate interactive UI.
+ *
+ * @param options - Event documentation options. See {@link WsDocOptions}.
+ *
+ * @example
+ * ```ts
+ * @WsDoc({
+ *   event: 'sendMessage',
+ *   description: 'Send a message to a room',
+ *   payload: { roomId: 'string', message: 'string' },
+ *   response: 'receiveMessage',
+ *   type: 'emit',
+ * })
+ * @SubscribeMessage('sendMessage')
+ * handleMessage(@MessageBody() dto: SendMessageDto) {}
+ * ```
+ */
+export declare const WsDoc: (options: WsDocOptions) => MethodDecorator;
+//# sourceMappingURL=ws-doc.decorator.d.ts.map

package/dist/decorators/ws-doc.decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-doc.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/ws-doc.decorator.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAMH;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AAIxD;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,iFAAiF;IACjF,KAAK,EAAE,MAAM,CAAC;IAEd,kEAAkE;IAClE,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;CAC7B;AAID;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,KAAK,GAAI,SAAS,YAAY,KAAG,eAK7C,CAAC"}

package/dist/decorators/ws-doc.decorator.js

@@ -0,0 +1,48 @@
+"use strict";
+/**
+ * nestjs-wsgate
+ *
+ * Copyright (c) 2026 Shaishab Chandra Shil (@shaishab316)
+ * MIT License — https://opensource.org/licenses/MIT
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WsDoc = exports.WSGATE_EVENT_METADATA = void 0;
+const common_1 = require("@nestjs/common");
+// ── Metadata Key ──────────────────────────────────────
+/**
+ * A unique metadata key for storing WebSocket event documentation
+ * on handler methods via `@WsDoc()`.
+ *
+ * @internal Do not change — this key is used internally by `WsgateExplorer`.
+ */
+exports.WSGATE_EVENT_METADATA = "wsgate:event_doc";
+// ── Decorator ─────────────────────────────────────────
+/**
+ * Marks a WebSocket gateway method as a documented event.
+ * Metadata is collected at bootstrap by `WsgateExplorer` and
+ * served via the nestjs-wsgate interactive UI.
+ *
+ * @param options - Event documentation options. See {@link WsDocOptions}.
+ *
+ * @example
+ * ```ts
+ * @WsDoc({
+ *   event: 'sendMessage',
+ *   description: 'Send a message to a room',
+ *   payload: { roomId: 'string', message: 'string' },
+ *   response: 'receiveMessage',
+ *   type: 'emit',
+ * })
+ * @SubscribeMessage('sendMessage')
+ * handleMessage(@MessageBody() dto: SendMessageDto) {}
+ * ```
+ */
+const WsDoc = (options) => {
+    // Apply defaults
+    options.type ?? (options.type = "emit");
+    return (0, common_1.SetMetadata)(exports.WSGATE_EVENT_METADATA, options);
+};
+exports.WsDoc = WsDoc;
+//# sourceMappingURL=ws-doc.decorator.js.map

package/dist/decorators/ws-doc.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-doc.decorator.js","sourceRoot":"","sources":["../../src/decorators/ws-doc.decorator.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAEH,2CAA6C;AAE7C,yDAAyD;AAEzD;;;;;GAKG;AACU,QAAA,qBAAqB,GAAG,kBAAkB,CAAC;AAsCxD,yDAAyD;AAEzD;;;;;;;;;;;;;;;;;;;GAmBG;AACI,MAAM,KAAK,GAAG,CAAC,OAAqB,EAAmB,EAAE;IAC9D,iBAAiB;IACjB,OAAO,CAAC,IAAI,KAAZ,OAAO,CAAC,IAAI,GAAK,MAAM,EAAC;IAExB,OAAO,IAAA,oBAAW,EAAC,6BAAqB,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC,CAAC;AALW,QAAA,KAAK,SAKhB"}

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * nestjs-wsgate
+ *
+ * Copyright (c) 2026 Shaishab Chandra Shil (@shaishab316)
+ * MIT License — https://opensource.org/licenses/MIT
+ *
+ * An interactive WebSocket documentation UI for NestJS.
+ * Like Swagger UI, but for Socket.IO gateway events.
+ *
+ * GitHub  : https://github.com/shaishab316/nestjs-wsgate
+ * npm     : https://www.npmjs.com/package/nestjs-wsgate
+ *
+ * @packageDocumentation
+ */
+export { WsgateModule } from "./wsgate.module";
+export type { WsgateOptions } from "./wsgate.module";
+export { WsgateExplorer } from "./wsgate.explorer";
+export type { WsEventMeta } from "./wsgate.explorer";
+export { WsDoc } from "./decorators/ws-doc.decorator";
+export type { WsDocOptions } from "./decorators/ws-doc.decorator";
+export { WSGATE_EVENT_METADATA } from "./decorators/ws-doc.decorator";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIrD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIrD,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AACtD,YAAY,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/index.js

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * nestjs-wsgate
+ *
+ * Copyright (c) 2026 Shaishab Chandra Shil (@shaishab316)
+ * MIT License — https://opensource.org/licenses/MIT
+ *
+ * An interactive WebSocket documentation UI for NestJS.
+ * Like Swagger UI, but for Socket.IO gateway events.
+ *
+ * GitHub  : https://github.com/shaishab316/nestjs-wsgate
+ * npm     : https://www.npmjs.com/package/nestjs-wsgate
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WSGATE_EVENT_METADATA = exports.WsDoc = exports.WsgateExplorer = exports.WsgateModule = void 0;
+// ── Core Module ───────────────────────────────────────
+// Main entry point for setting up the wsgate UI in a NestJS application.
+var wsgate_module_1 = require("./wsgate.module");
+Object.defineProperty(exports, "WsgateModule", { enumerable: true, get: function () { return wsgate_module_1.WsgateModule; } });
+// ── Explorer ──────────────────────────────────────────
+// Scans NestJS providers and collects @WsDoc() metadata at bootstrap.
+var wsgate_explorer_1 = require("./wsgate.explorer");
+Object.defineProperty(exports, "WsgateExplorer", { enumerable: true, get: function () { return wsgate_explorer_1.WsgateExplorer; } });
+// ── Decorator ─────────────────────────────────────────
+// Applied to gateway methods to mark them as documented socket events.
+var ws_doc_decorator_1 = require("./decorators/ws-doc.decorator");
+Object.defineProperty(exports, "WsDoc", { enumerable: true, get: function () { return ws_doc_decorator_1.WsDoc; } });
+var ws_doc_decorator_2 = require("./decorators/ws-doc.decorator");
+Object.defineProperty(exports, "WSGATE_EVENT_METADATA", { enumerable: true, get: function () { return ws_doc_decorator_2.WSGATE_EVENT_METADATA; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;;AAEH,yDAAyD;AACzD,yEAAyE;AACzE,iDAA+C;AAAtC,6GAAA,YAAY,OAAA;AAGrB,yDAAyD;AACzD,sEAAsE;AACtE,qDAAmD;AAA1C,iHAAA,cAAc,OAAA;AAGvB,yDAAyD;AACzD,uEAAuE;AACvE,kEAAsD;AAA7C,yGAAA,KAAK,OAAA;AAEd,kEAAsE;AAA7D,yHAAA,qBAAqB,OAAA"}