@eleven-am/pondsocket 0.1.134 → 0.1.136

package/channel/channel.js

@@ -104,27 +104,29 @@ class ChannelEngine {
     /**
      * @desc Removes a user from the channel
      * @param userId - The id of the user to remove
-     * @param graceful - Whether to remove the user gracefully or not
      */
-    removeUser(userId, graceful = false) {
+    removeUser(userId) {
         var _a;
         const user = __classPrivateFieldGet(this, _ChannelEngine_users, "f").get(userId);
         if (user) {
             __classPrivateFieldGet(this, _ChannelEngine_users, "f").delete(userId);
             __classPrivateFieldGet(this, _ChannelEngine_receiver, "f").unsubscribe(userId);
-            (_a = __classPrivateFieldGet(this, _ChannelEngine_presenceEngine, "f")) === null || _a === void 0 ? void 0 : _a.removePresence(userId, graceful);
+            const userPresence = (_a = __classPrivateFieldGet(this, _ChannelEngine_presenceEngine, "f")) === null || _a === void 0 ? void 0 : _a.removePresence(userId);
             if (__classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").leaveCallback) {
                 __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").leaveCallback({
-                    id: userId,
-                    assigns: user,
                     channel: new Channel(this),
+                    user: {
+                        id: userId,
+                        presence: userPresence !== null && userPresence !== void 0 ? userPresence : {},
+                        assigns: user,
+                    },
                 });
             }
             if (__classPrivateFieldGet(this, _ChannelEngine_users, "f").size === 0) {
                 __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").destroyChannel();
             }
         }
-        else if (!graceful) {
+        else {
             throw new pondError_1.ChannelError(`ChannelEngine: User with id ${userId} does not exist in channel ${this.name}`, 404, this.name);
         }
     }
@@ -153,7 +155,7 @@ class ChannelEngine {
             message: reason !== null && reason !== void 0 ? reason : 'Channel has been destroyed',
         });
         __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").destroyChannel();
-        __classPrivateFieldGet(this, _ChannelEngine_users, "f").forEach((_, userId) => __classPrivateFieldGet(this, _ChannelEngine_receiver, "f").unsubscribe(userId));
+        __classPrivateFieldGet(this, _ChannelEngine_users, "f").forEach((_, userId) => this.removeUser(userId));
     }
     /**
      * @desc Updates a user's assigns
@@ -263,7 +265,7 @@ class ChannelEngine {
 }
 exports.ChannelEngine = ChannelEngine;
 _ChannelEngine_receiver = new WeakMap(), _ChannelEngine_presenceEngine = new WeakMap(), _ChannelEngine_users = new WeakMap(), _ChannelEngine_parentEngine = new WeakMap(), _ChannelEngine_instances = new WeakSet(), _ChannelEngine_subscribe = function _ChannelEngine_subscribe(userId, onMessage) {
-    __classPrivateFieldGet(this, _ChannelEngine_receiver, "f").subscribeWith(userId, (_a) => {
+    return __classPrivateFieldGet(this, _ChannelEngine_receiver, "f").subscribeWith(userId, (_a) => {
         var { recipients } = _a, event = __rest(_a, ["recipients"]);
         if (recipients.includes(userId)) {
             onMessage(event);

package/endpoint/endpoint.js

@@ -117,13 +117,80 @@ class Endpoint {
         });
         socket.addEventListener('close', () => {
             __classPrivateFieldGet(this, _Endpoint_channels, "f")
-                .forEach((manager) => manager.removeUser(cache.clientId, true));
+                .forEach((manager) => manager.removeUser(cache.clientId));
         });
         socket.addEventListener('error', () => {
             __classPrivateFieldGet(this, _Endpoint_channels, "f")
-                .forEach((manager) => manager.removeUser(cache.clientId, true));
+                .forEach((manager) => manager.removeUser(cache.clientId));
         });
     }
+    /**
+     * @desc Builds an error message
+     * @param error - The error to build
+     * @private
+     */
+    buildError(error) {
+        const event = {
+            event: pondsocket_common_1.ErrorTypes.INVALID_MESSAGE,
+            action: pondsocket_common_1.ServerActions.ERROR,
+            channelName: pondsocket_common_1.SystemSender.ENDPOINT,
+            requestId: (0, pondsocket_common_1.uuid)(),
+            payload: {},
+        };
+        if (error instanceof SyntaxError) {
+            event.payload = {
+                message: 'Invalid JSON',
+            };
+        }
+        else if (error instanceof Error) {
+            event.event = pondsocket_common_1.ErrorTypes.INTERNAL_SERVER_ERROR;
+            event.payload = {
+                message: error.message,
+            };
+        }
+        else if (error instanceof pondError_1.PresenceError) {
+            event.event = pondsocket_common_1.ErrorTypes.PRESENCE_ERROR;
+            event.channelName = error.channel;
+            event.payload = {
+                message: error.message,
+                code: error.code,
+                action: error.event,
+            };
+        }
+        else if (error instanceof pondError_1.ChannelError) {
+            event.event = pondsocket_common_1.ErrorTypes.CHANNEL_ERROR;
+            event.channelName = error.channel;
+            event.payload = {
+                message: error.message,
+                code: error.code,
+            };
+        }
+        else if (error instanceof pondError_1.EndpointError) {
+            event.event = pondsocket_common_1.ErrorTypes.ENDPOINT_ERROR;
+            event.payload = {
+                message: error.message,
+                code: error.code,
+            };
+        }
+        else if (error instanceof zod_1.ZodError) {
+            const message = error.errors.map((error) => {
+                if ('expected' in error && 'received' in error) {
+                    return `Expected ${error.path.join('.')} to be ${error.expected}, but received ${error.received}`;
+                }
+                return `${error.path.join('.')} ${error.message}`;
+            }).join(', ');
+            event.payload = {
+                message,
+                code: 400,
+            };
+        }
+        else {
+            event.payload = {
+                message: 'Unknown error',
+            };
+        }
+        return event;
+    }
 }
 exports.Endpoint = Endpoint;
 _Endpoint_middleware = new WeakMap(), _Endpoint_channels = new WeakMap(), _Endpoint_sockets = new WeakMap(), _Endpoint_instances = new WeakSet(), _Endpoint_sendMessage = function _Endpoint_sendMessage(socket, message) {
@@ -161,65 +228,12 @@ _Endpoint_middleware = new WeakMap(), _Endpoint_channels = new WeakMap(), _Endpo
             throw new Error(`GatewayEngine: Action ${message.action} does not exist`);
     }
 }, _Endpoint_readMessage = function _Endpoint_readMessage(cache, message) {
-    const errorMessage = {
-        event: pondsocket_common_1.ErrorTypes.INVALID_MESSAGE,
-        action: pondsocket_common_1.ServerActions.ERROR,
-        channelName: pondsocket_common_1.SystemSender.ENDPOINT,
-        requestId: (0, pondsocket_common_1.uuid)(),
-        payload: {},
-    };
     try {
         const data = JSON.parse(message);
         const result = schema_1.clientMessageSchema.parse(data);
         __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_handleMessage).call(this, cache, result);
     }
     catch (e) {
-        if (e instanceof zod_1.ZodError) {
-            errorMessage.payload = {
-                message: e.message,
-                code: 400,
-            };
-        }
-        else if (e instanceof SyntaxError) {
-            errorMessage.payload = {
-                message: 'Invalid JSON',
-            };
-        }
-        else if (e instanceof Error) {
-            errorMessage.event = pondsocket_common_1.ErrorTypes.INTERNAL_SERVER_ERROR;
-            errorMessage.payload = {
-                message: e.message,
-            };
-        }
-        else if (e instanceof pondError_1.PresenceError) {
-            errorMessage.event = pondsocket_common_1.ErrorTypes.PRESENCE_ERROR;
-            errorMessage.channelName = e.channel;
-            errorMessage.payload = {
-                message: e.message,
-                code: e.code,
-                action: e.event,
-            };
-        }
-        else if (e instanceof pondError_1.ChannelError) {
-            errorMessage.event = pondsocket_common_1.ErrorTypes.CHANNEL_ERROR;
-            errorMessage.channelName = e.channel;
-            errorMessage.payload = {
-                message: e.message,
-                code: e.code,
-            };
-        }
-        else if (e instanceof pondError_1.EndpointError) {
-            errorMessage.event = pondsocket_common_1.ErrorTypes.ENDPOINT_ERROR;
-            errorMessage.payload = {
-                message: e.message,
-                code: e.code,
-            };
-        }
-        else {
-            errorMessage.payload = {
-                message: 'Unknown error',
-            };
-        }
-        __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_sendMessage).call(this, cache.socket, errorMessage);
+        __classPrivateFieldGet(this, _Endpoint_instances, "m", _Endpoint_sendMessage).call(this, cache.socket, this.buildError(e));
     }
 };

package/index.d.ts

@@ -1,5 +1,5 @@
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-expect-error
-import { PondSocket } from './types';
+import type { PondSocket } from './types';
 
 export default PondSocket;

package/lobby/lobby.js

@@ -79,11 +79,10 @@ class LobbyEngine {
     /**
      * @desc Removes a user from all channels
      * @param clientId - The client id of the user to remove
-     * @param graceful - Whether to gracefully remove the user or not
      */
-    removeUser(clientId, graceful = false) {
+    removeUser(clientId) {
         __classPrivateFieldGet(this, _LobbyEngine_channels, "f").forEach((channel) => {
-            channel.removeUser(clientId, graceful);
+            channel.removeUser(clientId);
         });
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket",
-  "version": "0.1.134",
+  "version": "0.1.136",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",
@@ -34,13 +34,13 @@
     "url": "git+https://github.com/Eleven-am/pondSocket.git"
   },
   "dependencies": {
-    "@eleven-am/pondsocket-common": "^0.0.7",
+    "@eleven-am/pondsocket-common": "^0.0.10",
     "ws": "^8.16.0",
     "zod": "^3.22.4"
   },
   "devDependencies": {
     "@types/jest": "^29.5.11",
-    "@types/node": "^20.11.4",
+    "@types/node": "^20.11.5",
     "@types/websocket": "^1.0.10",
     "@types/ws": "^8.5.10",
     "@typescript-eslint/eslint-plugin": "^6.19.0",

package/presence/presence.js

@@ -62,9 +62,8 @@ class PresenceEngine {
     /**
      * @desc Removes a presence from the presence engine
      * @param presenceKey - The key of the presence
-     * @param graceful - Whether to gracefully remove the presence
      */
-    removePresence(presenceKey, graceful = false) {
+    removePresence(presenceKey) {
         const presence = __classPrivateFieldGet(this, _PresenceEngine_presenceMap, "f").get(presenceKey);
         if (presence) {
             __classPrivateFieldGet(this, _PresenceEngine_presenceMap, "f").delete(presenceKey);
@@ -73,11 +72,12 @@ class PresenceEngine {
                 presence: Array.from(__classPrivateFieldGet(this, _PresenceEngine_presenceMap, "f").values()),
             });
         }
-        else if (!graceful) {
+        else {
             const code = 404;
             const message = `PresenceEngine: Presence with key ${presenceKey} does not exist`;
             throw new pondError_1.PresenceError(message, code, __classPrivateFieldGet(this, _PresenceEngine_channel, "f").name, pondsocket_common_1.PresenceEventTypes.LEAVE);
         }
+        return presence;
     }
     /**
      * @desc Updates a presence

package/types.d.ts

@@ -1,57 +1,23 @@
-import { Server as HTTPServer, IncomingHttpHeaders } from 'http';
-
+import { Server as HTTPServer } from 'http';
+
+import {
+    PondMessage,
+    PondPresence,
+    PondAssigns,
+    PondEvent,
+    PondPath,
+    JoinParams,
+    PondEventMap,
+    IncomingConnection, UserData,
+} from '@eleven-am/pondsocket-common';
 import { WebSocketServer } from 'ws';
 
-export type default_t<T = any> = Record<string, T>;
-type IsParam<Path> = Path extends `:${infer Param}` ? Param : never;
-
-type FilteredParams<Path> = Path extends `${infer First}/${infer Second}`
-    ? IsParam<First> | FilteredParams<Second>
-    : IsParam<Path>
-
-type Params<Path> = {
-    [Key in FilteredParams<Path>]: string
-}
-
-type PondPath<Path extends string> = Path | RegExp;
-
-type EventParams<Path> = {
-    query: Record<string, string>;
-    params: Params<Path>;
-}
-
-type PondObject = default_t;
-type PondPresence = PondObject;
-type PondMessage = PondObject;
-type PondAssigns = PondObject;
-type JoinParams = PondObject;
-
-type PondEvent<Path> = EventParams<Path> & {
-    payload: PondMessage;
-    event: string;
-}
-
-type IncomingConnection<Path> = EventParams<Path> & {
-    id: string;
-    headers: IncomingHttpHeaders;
-    address: string;
-}
-
-interface LeaveEvent<EventTypes extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
-    id: string;
-    assigns: AssignType;
+interface LeaveEvent<EventTypes extends PondEventMap = PondEventMap, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
+    user: UserData<PresenceType, AssignType>;
     channel: Channel<EventTypes, PresenceType, AssignType>;
 }
 
-type LeaveCallback<EventTypes extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> = (event: LeaveEvent<EventTypes, PresenceType, AssignType>) => void;
-
-type PondEvenType = { [key: string]: PondMessage };
-
-interface UserData<PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
-    assigns: AssignType;
-    presence: PresenceType;
-    id: string;
-}
+type LeaveCallback<EventTypes extends PondEventMap = PondEventMap, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> = (event: LeaveEvent<EventTypes, PresenceType, AssignType>) => void;
 
 declare class AbstractRequest<Path extends string, PresenceType extends PondPresence, AssignType extends PondAssigns> {
     event: PondEvent<Path>;
@@ -69,7 +35,7 @@ declare class EventRequest<Path extends string, PresenceType extends PondPresenc
     channel: Channel;
 }
 
-declare class EventResponse<EventType extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
+declare class EventResponse<EventType extends PondEventMap = PondEventMap, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
     /**
      * @desc Whether the server has responded to the request
      */
@@ -176,7 +142,7 @@ declare class Endpoint {
      *         response.reject('You are not an admin', 403);
      * });
      */
-    createChannel<Path extends string, EventType extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> (path: PondPath<Path>, handler: (request: JoinRequest<Path, PresenceType, AssignType>, response: JoinResponse<EventType, PresenceType, AssignType>) => void | Promise<void>): PondChannel<EventType, PresenceType, AssignType>;
+    createChannel<Path extends string, EventType extends PondEventMap = PondEventMap, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> (path: PondPath<Path>, handler: (request: JoinRequest<Path, PresenceType, AssignType>, response: JoinResponse<EventType, PresenceType, AssignType>) => void | Promise<void>): PondChannel<EventType, PresenceType, AssignType>;
 
     /**
      * @desc Broadcasts a message to all clients connected to this endpoint
@@ -192,7 +158,7 @@ declare class Endpoint {
     closeConnection (clientIds: string | string[]): void;
 }
 
-export declare class Channel<EventType extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
+export declare class Channel<EventType extends PondEventMap = PondEventMap, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
     /**
      * The name of the channel.
      */
@@ -281,7 +247,7 @@ declare class JoinRequest<Path extends string, PresenceType extends PondPresence
     channel: Channel;
 }
 
-declare class JoinResponse<EventType extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
+declare class JoinResponse<EventType extends PondEventMap = PondEventMap, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
     /**
      * @desc Whether the server has responded to the request
      */
@@ -365,7 +331,7 @@ declare class ConnectionResponse {
     send (event: string, payload: PondMessage, assigns?: PondAssigns): void;
 }
 
-export declare class PondChannel <EventType extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
+export declare class PondChannel <EventType extends PondEventMap = PondEventMap, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
     /**
      * @desc Handles an event request made by a user
      * @param event - The event to listen for

package/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });