@eleven-am/pondsocket 0.1.78 → 0.1.81

package/nest.d.ts

@@ -13,7 +13,7 @@ import  {
     GetConnectionRequest, GetConnectionResponse,
     GetConnectionQuery, GetConnectionHeaders,
     GetConnectionRequestId, GetEventPayload,
-    GetUserData, GetUserPresence, GetInternalChannel,
+    GetUserData, GetUserPresences, GetInternalChannel,
 } from './types';
 
 export {
@@ -29,5 +29,5 @@ export {
     GetConnectionRequestId, GetEventPayload,
     GetConnectionParams, GetConnectionRequest,
     GetConnectionResponse, GetConnectionHeaders,
-    GetUserData, GetUserPresence, GetInternalChannel,
+    GetUserData, GetUserPresences, GetInternalChannel,
 }

package/nest.js

@@ -20,7 +20,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PondSocketModule = exports.Endpoints = exports.Endpoint = exports.Channels = exports.ChannelInstance = exports.Channel = exports.OnConnectionRequest = exports.OnEvent = exports.OnJoinRequest = exports.GetConnectionQuery = exports.GetConnectionHeaders = exports.GetConnectionParams = exports.GetConnectionRequestId = exports.GetConnectionResponse = exports.GetConnectionRequest = exports.GetEventRequest = exports.GetEventResponse = exports.GetEventQuery = exports.GetEventParams = exports.GetEventPayload = exports.GetUserPresence = exports.GetInternalChannel = exports.GetUserData = exports.GetJoinParams = exports.GetJoinResponse = exports.GetJoinRequest = void 0;
+exports.PondSocketModule = exports.Endpoints = exports.Endpoint = exports.Channels = exports.ChannelInstance = exports.Channel = exports.OnConnectionRequest = exports.OnEvent = exports.OnJoinRequest = exports.GetConnectionQuery = exports.GetConnectionHeaders = exports.GetConnectionParams = exports.GetConnectionRequestId = exports.GetConnectionResponse = exports.GetConnectionRequest = exports.GetEventRequest = exports.GetEventResponse = exports.GetEventQuery = exports.GetEventParams = exports.GetEventPayload = exports.GetUserPresences = exports.GetInternalChannel = exports.GetUserData = exports.GetJoinParams = exports.GetJoinResponse = exports.GetJoinRequest = void 0;
 const common_1 = require("@nestjs/common");
 require("reflect-metadata");
 const pondSocket_1 = require("./server/pondSocket");
@@ -139,10 +139,10 @@ function GetInternalChannel() {
     return createParamDecorator(internalChannelKey, 'InternalChannel decorator already applied');
 }
 exports.GetInternalChannel = GetInternalChannel;
-function GetUserPresence() {
+function GetUserPresences() {
     return createParamDecorator(userPresenceKey, 'UserPresence decorator already applied');
 }
-exports.GetUserPresence = GetUserPresence;
+exports.GetUserPresences = GetUserPresences;
 function GetEventPayload() {
     return createParamDecorator(eventPayloadKey, 'EventPayload decorator already applied');
 }
@@ -245,6 +245,7 @@ function resolveJoinParameters(request, response, target, propertyKey) {
 }
 function resolveEventParameters(request, response, target, propertyKey) {
     const userDataIndex = resolveParamDecorator(userDataKey, target, propertyKey);
+    const userPresenceIndex = resolveParamDecorator(userPresenceKey, target, propertyKey);
     const internalChannelIndex = resolveParamDecorator(internalChannelKey, target, propertyKey);
     const eventParamsIndex = resolveParamDecorator(eventParamsKey, target, propertyKey);
     const eventQueryIndex = resolveParamDecorator(eventQueryKey, target, propertyKey);
@@ -259,12 +260,12 @@ function resolveEventParameters(request, response, target, propertyKey) {
         eventPayloadIndex,
         eventResponseIndex,
         eventRequestIndex,
+        userPresenceIndex,
     ].filter((index) => typeof index === 'number');
     const rejectedKeys = [
         joinRequestKey,
         joinResponseKey,
         joinParamsKey,
-        userPresenceKey,
         connectionRequestKey,
         connectionResponseKey,
         connectionRequestIdKey,
@@ -294,6 +295,8 @@ function resolveEventParameters(request, response, target, propertyKey) {
                 return response;
             case eventRequestIndex:
                 return request;
+            case userPresenceIndex:
+                return request.presence;
             default:
                 throw new Error('Invalid parameter decorator');
         }
@@ -496,7 +499,8 @@ function Endpoint(path = '*') {
     };
 }
 exports.Endpoint = Endpoint;
-function Endpoints(endpoints) {
+function Endpoints(metadata) {
+    const { endpoints, imports, exports = [], providers = [], isGlobal = false } = metadata;
     return (constructor) => {
         const channels = endpoints.reduce((acc, endpoint) => {
             const { get } = manageChannels(endpoint.prototype);
@@ -505,13 +509,23 @@ function Endpoints(endpoints) {
         }, []);
         const { set } = manageEndpoints(constructor.prototype);
         set(endpoints);
-        // eslint-disable-next-line new-cap
-        const globalConstructor = (0, common_1.Global)()(constructor);
+        if (isGlobal) {
+            return (0, common_1.applyDecorators)(
+            // eslint-disable-next-line new-cap
+            (0, common_1.Global)(), 
+            // eslint-disable-next-line new-cap
+            (0, common_1.Module)({
+                imports,
+                exports: [...exports, ...channels],
+                providers: [...providers, ...endpoints, ...channels],
+            }))(constructor);
+        }
         // eslint-disable-next-line new-cap
         return (0, common_1.Module)({
-            providers: [...endpoints, ...channels],
-            exports: [...endpoints, ...channels],
-        })(globalConstructor);
+            imports,
+            exports: [...exports, ...channels],
+            providers: [...providers, ...endpoints, ...channels],
+        })(constructor);
     };
 }
 exports.Endpoints = Endpoints;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket",
-  "version": "0.1.78",
+  "version": "0.1.81",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",
@@ -29,8 +29,8 @@
     "url": "git+https://github.com/Eleven-am/pondSocket.git"
   },
   "dependencies": {
-    "@nestjs/common": "^10.2.10",
-    "@nestjs/core": "^10.2.10",
+    "@nestjs/common": "^10.3.0",
+    "@nestjs/core": "^10.3.0",
     "reflect-metadata": "^0.1.14",
     "websocket": "^1.0.34",
     "ws": "^8.15.1"
@@ -38,13 +38,13 @@
   "devDependencies": {
     "@types/express": "^4.17.21",
     "@types/jest": "^29.5.11",
-    "@types/node": "^20.10.4",
+    "@types/node": "^20.10.5",
     "@types/websocket": "^1.0.10",
     "@types/ws": "^8.5.10",
-    "@typescript-eslint/eslint-plugin": "^6.14.0",
-    "eslint": "^8.55.0",
+    "@typescript-eslint/eslint-plugin": "^6.15.0",
+    "eslint": "^8.56.0",
     "eslint-plugin-file-progress": "^1.3.0",
-    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-import": "^2.29.1",
     "jest": "^29.7.0",
     "superwstest": "^2.0.3",
     "ts-jest": "^29.1.1",

package/types.d.ts

@@ -1,3 +1,4 @@
+import { ModuleMetadata } from '@nestjs/common/interfaces/modules/module-metadata.interface';
 import { Server as HTTPServer, IncomingHttpHeaders } from 'http';
 
 import type { ModuleRef, HttpAdapterHost } from '@nestjs/core';
@@ -7,6 +8,7 @@ import { WebSocketServer } from 'ws';
 type Unsubscribe = () => void;
 
 type Constructor<T> = new (...args: any[]) => T;
+declare type PropertyDecorator = (target: Object, propertyKey: string | symbol) => void;
 declare type ClassDecorator = <TFunction extends Function>(target: TFunction) => TFunction | void;
 declare type MethodDecorator = <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void;
 declare type ParameterDecorator = (target: Object, propertyKey: string | symbol | undefined, parameterIndex: number) => void;
@@ -48,6 +50,11 @@ interface UserAssigns {
     [userId: string]: PondAssigns;
 }
 
+interface Metadata extends Omit<ModuleMetadata, 'controllers'> {
+    endpoints: Constructor<NonNullable<unknown>>[];
+    isGlobal?: boolean;
+}
+
 type PondEvent<Path> = EventParams<Path> & {
     payload: PondMessage;
     event: string;
@@ -652,10 +659,10 @@ declare function GetUserData(): ParameterDecorator;
 declare function GetInternalChannel(): ParameterDecorator;
 
 /**
- * @desc The Decorator for retrieving the UserPresence object from the request in a handler
- * @returns {PondPresence}
+ * @desc The Decorator for retrieving the UserPresences object from the request in a handler
+ * @returns {UserPresences}
  */
-declare function GetUserPresence(): ParameterDecorator;
+declare function GetUserPresences(): ParameterDecorator;
 
 /**
  * @desc The Decorator for retrieving the event payload from the request in a handler
@@ -724,19 +731,18 @@ declare function GetConnectionHeaders(): ParameterDecorator;
 declare function GetConnectionQuery(): ParameterDecorator;
 
 /**
- * @desc Marks a method as a handler for JoinRequest events.
- * @param - The path for the JoinRequest event.
+ * @desc Marks a method as a handler for JoinRequest events. Throwing an error will reject the request with the error message.
  */
 declare function OnJoinRequest(): MethodDecorator;
 
 /**
- * @desc Marks a method as a handler for events with the specified name.
+ * @desc Marks a method as a handler for events with the specified name. Throwing an error will reject the request with the error message
  * @param event - The name of the event to handle.
  */
 declare function OnEvent(event?: string): MethodDecorator;
 
 /**
- * @desc Marks a method as a handler for ConnectionRequest events.
+ * @desc Marks a method as a handler for ConnectionRequest events. Throwing an error will reject the request with the error message.
  */
 declare function OnConnectionRequest(): MethodDecorator;
 
@@ -765,9 +771,9 @@ declare function DEndpoint(path?: string): ClassDecorator;
 
 /**
  * Decorator to mark a class as having multiple endpoints.
- * @param endpoints - The array of endpoints.
+ * @param metadata - The metadata for the endpoints.
  */
-declare function Endpoints(endpoints: Constructor<NonNullable<unknown>>[]): ClassDecorator;
+declare function Endpoints(metadata: Metadata): ClassDecorator;
 
 declare class PondSocketModule {
     /**