@eleven-am/pondsocket 0.1.79 → 0.1.82

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.Channel = exports.ChannelInstance = 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");
@@ -44,9 +44,18 @@ const connectionHeadersKey = Symbol('connectionHeadersKey');
 const onJoinHandlerKey = Symbol('onJoinHandlerKey');
 const onEventHandlerKey = Symbol('onEventHandlerKey');
 const onConnectionHandlerKey = Symbol('onConnectionHandlerKey');
-const channelsKey = Symbol('channelsKey');
-const endpointsKey = Symbol('endpointsKey');
 const channelInstanceKey = Symbol('channelInstanceKey');
+const channelClassKey = Symbol('channel');
+const endpointClassKey = Symbol('endpoint');
+const channelsClassKey = Symbol('channels');
+const endpointsClassKey = Symbol('endpoints');
+function createClassDecorator(key, value) {
+    return (0, common_1.applyDecorators)((0, common_1.Injectable)(), (0, common_1.SetMetadata)(key, value));
+}
+function getClassMetadata(key, target) {
+    var _a;
+    return (_a = Reflect.getMetadata(key, target)) !== null && _a !== void 0 ? _a : null;
+}
 function createParamDecorator(key, error) {
     return (target, propertyKey, parameterIndex) => {
         const existingParams = Reflect.getMetadata(key, target, propertyKey);
@@ -63,16 +72,6 @@ function resolveParamDecorator(key, target, propertyKey) {
     }
     return index;
 }
-function createClassDecorator(key, target) {
-    return {
-        get() {
-            return (Reflect.getMetadata(key, target) || []);
-        },
-        set(value) {
-            Reflect.defineMetadata(key, value, target);
-        },
-    };
-}
 function manageClassData(key, target) {
     return {
         get() {
@@ -113,12 +112,6 @@ function manageEventHandlers(target) {
 function manageConnectionHandlers(target) {
     return manageHandlers(onConnectionHandlerKey, target);
 }
-function manageChannels(target) {
-    return createClassDecorator(channelsKey, target);
-}
-function manageEndpoints(target) {
-    return createClassDecorator(endpointsKey, target);
-}
 function GetJoinRequest() {
     return createParamDecorator(joinRequestKey, 'JoinRequest decorator already applied');
 }
@@ -139,10 +132,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 +238,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 +253,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 +288,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');
         }
@@ -357,9 +353,9 @@ function OnJoinRequest() {
     return (target, propertyKey, descriptor) => {
         const originalMethod = descriptor.value;
         const { set } = manageJoinHandlers(target);
-        set('', (request, response) => __awaiter(this, void 0, void 0, function* () {
+        set('', (instance, request, response) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield originalMethod.apply(target, resolveJoinParameters(request, response, target, propertyKey));
+                const data = yield originalMethod.apply(instance, resolveJoinParameters(request, response, target, propertyKey));
                 if (!response.hasResponded) {
                     if (data) {
                         const { event } = data, rest = __rest(data, ["event"]);
@@ -381,9 +377,9 @@ function OnEvent(event = '*') {
     return (target, propertyKey, descriptor) => {
         const originalMethod = descriptor.value;
         const { set } = manageEventHandlers(target);
-        set(event, (request, response) => __awaiter(this, void 0, void 0, function* () {
+        set(event, (instance, request, response) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield originalMethod.apply(target, resolveEventParameters(request, response, target, propertyKey));
+                const data = yield originalMethod.apply(instance, resolveEventParameters(request, response, target, propertyKey));
                 if (!response.hasResponded) {
                     if (data) {
                         const { event } = data, rest = __rest(data, ["event"]);
@@ -405,9 +401,9 @@ function OnConnectionRequest() {
     return (target, propertyKey, descriptor) => {
         const originalMethod = descriptor.value;
         const { set } = manageConnectionHandlers(target);
-        set('', (request, response) => __awaiter(this, void 0, void 0, function* () {
+        set('', (instance, request, response) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield originalMethod.apply(target, resolveConnectionParameters(request, response, target, propertyKey));
+                const data = yield originalMethod.apply(instance, resolveConnectionParameters(request, response, target, propertyKey));
                 if (!response.hasResponded) {
                     if (data) {
                         const { event } = data, rest = __rest(data, ["event"]);
@@ -425,34 +421,9 @@ function OnConnectionRequest() {
     };
 }
 exports.OnConnectionRequest = OnConnectionRequest;
-function Channel(path = '*') {
-    return (constructor) => class extends constructor {
-        _setEndpoint(endpoint) {
-            const channel = endpoint.createChannel(path, (request, response) => __awaiter(this, void 0, void 0, function* () {
-                const { get } = manageJoinHandlers(this);
-                const [handler] = get();
-                if (handler) {
-                    yield handler.value(request, response);
-                }
-                else {
-                    response.accept();
-                }
-            }));
-            const { set } = manageChannelInstance(constructor.prototype);
-            const { get } = manageEventHandlers(this);
-            set(channel);
-            get().forEach((handler) => {
-                channel.onEvent(handler.path, (request, response) => __awaiter(this, void 0, void 0, function* () {
-                    yield handler.value(request, response);
-                }));
-            });
-        }
-    };
-}
-exports.Channel = Channel;
 function ChannelInstance() {
     return (target, propertyKey) => {
-        const { get } = manageChannelInstance(target.constructor.prototype);
+        const { get } = manageChannelInstance(target);
         Object.defineProperty(target, propertyKey, {
             get() {
                 return get();
@@ -464,54 +435,28 @@ function ChannelInstance() {
     };
 }
 exports.ChannelInstance = ChannelInstance;
-function Channels(channels) {
-    return (constructor) => {
-        const { set } = manageChannels(constructor.prototype);
-        set(channels);
-        return constructor;
-    };
-}
-exports.Channels = Channels;
-function Endpoint(path = '*') {
-    return (constructor) => class extends constructor {
-        _setSocket(moduleRef, socket) {
-            const { get } = manageConnectionHandlers(this);
-            const { get: getChannels } = manageChannels(this);
-            const [handler] = get();
-            const endpoint = socket.createEndpoint(path, (request, response) => __awaiter(this, void 0, void 0, function* () {
-                if (handler) {
-                    yield handler.value(request, response);
-                }
-                else {
-                    response.accept();
-                }
-            }));
-            getChannels().forEach((channel) => {
-                const chan = moduleRef.get(channel, {
-                    strict: false,
-                });
-                chan._setEndpoint(endpoint);
-            });
-        }
-    };
-}
+const Channel = (path = '*') => createClassDecorator(channelClassKey, path);
+exports.Channel = Channel;
+const SetEndpoint = (path = '*') => createClassDecorator(endpointClassKey, path);
+const SetChannels = (channels) => createClassDecorator(channelsClassKey, channels);
+const getChannels = (target) => {
+    var _a;
+    return (_a = getClassMetadata(channelsClassKey, target)) !== null && _a !== void 0 ? _a : [];
+};
+const Endpoint = (metadata) => (0, common_1.applyDecorators)(SetChannels(metadata.channels), SetEndpoint(metadata.path));
 exports.Endpoint = Endpoint;
-function Endpoints(endpoints) {
-    return (constructor) => {
-        const channels = endpoints.reduce((acc, endpoint) => {
-            const { get } = manageChannels(endpoint.prototype);
-            const channels = get();
-            return [...acc, ...channels];
-        }, []);
-        const { set } = manageEndpoints(constructor.prototype);
-        set(endpoints);
-        // eslint-disable-next-line new-cap
-        return (0, common_1.Module)({
-            providers: [...endpoints, ...channels],
-            exports: [...endpoints, ...channels],
-        })(constructor);
-    };
-}
+const Endpoints = ({ endpoints, providers = [], imports = [], exports = [], }) => (target) => {
+    const channels = endpoints.flatMap((endpoint) => getChannels(endpoint));
+    return (0, common_1.applyDecorators)(
+    // eslint-disable-next-line new-cap
+    (0, common_1.SetMetadata)(endpointsClassKey, endpoints), 
+    // eslint-disable-next-line new-cap
+    (0, common_1.Module)({
+        imports,
+        providers: [...providers, ...endpoints, ...channels],
+        exports: [...exports, ...channels],
+    }))(target);
+};
 exports.Endpoints = Endpoints;
 class PondSocketModule {
     constructor(moduleRef, adapterHost) {
@@ -519,16 +464,58 @@ class PondSocketModule {
         this.adapterHost = adapterHost;
         const expressInstance = this.adapterHost.httpAdapter;
         const server = expressInstance.getHttpServer();
-        this.socket = new pondSocket_1.PondSocket(server);
+        const socket = new pondSocket_1.PondSocket(server);
         expressInstance.listen = (...args) => {
-            const { get } = manageEndpoints(this);
-            get().map((endpoint) => {
-                const instance = this.moduleRef.get(endpoint, { strict: false });
-                instance._setSocket(this.moduleRef, this.socket);
-                return instance;
-            });
-            this.socket.listen(...args);
+            var _a;
+            const endpoints = (_a = getClassMetadata(endpointsClassKey, this.constructor)) !== null && _a !== void 0 ? _a : [];
+            endpoints.forEach((endpoint) => this.manageEndpoint(socket, endpoint));
+            return socket.listen(...args);
         };
     }
+    manageEndpoint(socket, endpoint) {
+        const endpointMetadata = getClassMetadata(endpointClassKey, endpoint);
+        if (!endpointMetadata) {
+            return;
+        }
+        const instance = this.moduleRef.get(endpoint, { strict: false });
+        const pondEndpoint = socket.createEndpoint(endpointMetadata, (request, response) => __awaiter(this, void 0, void 0, function* () {
+            const { get } = manageConnectionHandlers(instance);
+            const [handler] = get();
+            if (handler) {
+                yield handler.value(instance, request, response);
+            }
+            else {
+                response.accept();
+            }
+        }));
+        getChannels(endpoint).forEach((channel) => {
+            this.manageChannel(channel, pondEndpoint);
+        });
+    }
+    manageChannel(channel, endpoint) {
+        const channelMetadata = getClassMetadata(channelClassKey, channel);
+        if (!channelMetadata) {
+            return;
+        }
+        const instance = this.moduleRef.get(channel, { strict: false });
+        const channelInstance = endpoint.createChannel(channelMetadata, (request, response) => __awaiter(this, void 0, void 0, function* () {
+            const { get } = manageJoinHandlers(instance);
+            const [handler] = get();
+            if (handler) {
+                yield handler.value(instance, request, response);
+            }
+            else {
+                response.accept();
+            }
+        }));
+        const { get: getEventHandlers } = manageEventHandlers(instance);
+        const { set } = manageChannelInstance(instance);
+        getEventHandlers().forEach((handler) => {
+            channelInstance.onEvent(handler.path, (request, response) => __awaiter(this, void 0, void 0, function* () {
+                yield handler.value(instance, request, response);
+            }));
+        });
+        set(channelInstance);
+    }
 }
 exports.PondSocketModule = PondSocketModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket",
-  "version": "0.1.79",
+  "version": "0.1.82",
   "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 {
     /**