@eleven-am/pondsocket 0.1.60 → 0.1.62

package/channel/channel.js

@@ -70,6 +70,12 @@ class ChannelEngine {
             __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);
+            if (__classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").leaveCallback) {
+                __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").leaveCallback({
+                    userId,
+                    assigns: user,
+                });
+            }
             if (__classPrivateFieldGet(this, _ChannelEngine_users, "f").size === 0) {
                 __classPrivateFieldGet(this, _ChannelEngine_parentEngine, "f").destroyChannel();
             }

package/channel/eventRequest.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventRequest = void 0;
+const channel_1 = require("./channel");
 const abstractRequest_1 = require("../abstracts/abstractRequest");
 const pondError_1 = require("../errors/pondError");
 class EventRequest extends abstractRequest_1.AbstractRequest {
@@ -17,5 +18,8 @@ class EventRequest extends abstractRequest_1.AbstractRequest {
         }
         return assigns;
     }
+    get client() {
+        return new channel_1.Client(this._engine);
+    }
 }
 exports.EventRequest = EventRequest;

package/lobby/lobby.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _LobbyEngine_channels, _LobbyEngine_middleware, _PondChannel_lobby;
+var _LobbyEngine_channels, _LobbyEngine_middleware, _LobbyEngine_leaveCallback, _PondChannel_lobby;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PondChannel = exports.LobbyEngine = void 0;
 const middleware_1 = require("../abstracts/middleware");
@@ -20,6 +20,7 @@ class LobbyEngine {
     constructor() {
         _LobbyEngine_channels.set(this, void 0);
         _LobbyEngine_middleware.set(this, void 0);
+        _LobbyEngine_leaveCallback.set(this, void 0);
         __classPrivateFieldSet(this, _LobbyEngine_channels, new Set(), "f");
         __classPrivateFieldSet(this, _LobbyEngine_middleware, new middleware_1.Middleware(), "f");
     }
@@ -42,6 +43,13 @@ class LobbyEngine {
             next();
         });
     }
+    /**
+     * @desc Handles the leave event for a user, can occur when a user disconnects or leaves a channel, use this to clean up any resources
+     * @param callback - The callback to execute when a user leaves
+     */
+    onLeave(callback) {
+        __classPrivateFieldSet(this, _LobbyEngine_leaveCallback, callback, "f");
+    }
     /**
      * @desc Broadcasts a message to all users in a channel
      * @param event - The event to broadcast
@@ -127,6 +135,7 @@ class LobbyEngine {
         const parentEngine = {
             execute,
             destroyChannel,
+            leaveCallback: __classPrivateFieldGet(this, _LobbyEngine_leaveCallback, "f"),
         };
         const newChannel = new channel_1.ChannelEngine(channelName, parentEngine);
         __classPrivateFieldGet(this, _LobbyEngine_channels, "f").add(newChannel);
@@ -134,7 +143,7 @@ class LobbyEngine {
     }
 }
 exports.LobbyEngine = LobbyEngine;
-_LobbyEngine_channels = new WeakMap(), _LobbyEngine_middleware = new WeakMap();
+_LobbyEngine_channels = new WeakMap(), _LobbyEngine_middleware = new WeakMap(), _LobbyEngine_leaveCallback = new WeakMap();
 class PondChannel {
     constructor(lobby) {
         _PondChannel_lobby.set(this, void 0);
@@ -169,6 +178,13 @@ class PondChannel {
     broadcast(event, payload, channelName) {
         __classPrivateFieldGet(this, _PondChannel_lobby, "f").broadcast(event, payload, channelName);
     }
+    /**
+     * @desc Handles the leave event for a user, can occur when a user disconnects or leaves a channel, use this to clean up any resources
+     * @param callback - The callback to execute when a user leaves
+     */
+    onLeave(callback) {
+        __classPrivateFieldGet(this, _PondChannel_lobby, "f").onLeave(callback);
+    }
 }
 exports.PondChannel = PondChannel;
 _PondChannel_lobby = new WeakMap();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket",
-  "version": "0.1.60",
+  "version": "0.1.62",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",

package/types.d.ts

@@ -4,6 +4,7 @@ import { WebSocketServer } from 'ws';
 
 type Unsubscribe = () => void;
 
+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}`
@@ -21,12 +22,7 @@ type EventParams<Path> = {
     params: Params<Path>;
 }
 
-type Primitives = number | string | boolean | null | undefined;
-
-type PondObject = {
-    [key: string]: Primitives | PondObject | PondObject[];
-}
-
+type PondObject = default_t;
 type PondPresence = PondObject;
 type PondMessage = PondObject;
 type PondAssigns = PondObject;
@@ -56,6 +52,13 @@ type IncomingConnection<Path> = EventParams<Path> & {
     address: string;
 }
 
+interface LeaveEvent {
+    userId: string;
+    assigns: PondAssigns;
+}
+
+type LeaveCallback = (event: LeaveEvent) => void;
+
 interface UserData {
     assigns: PondAssigns;
     presence: PondPresence;
@@ -106,6 +109,8 @@ declare abstract class PondResponse {
 
 declare class EventRequest<Path extends string> extends AbstractRequest<Path> {
     user: UserData;
+
+    client: Client;
 }
 
 declare class EventResponse extends PondResponse {
@@ -477,6 +482,12 @@ export declare class PondChannel {
      *});
      */
     broadcast (event: string, payload: PondMessage, channelName?: string): void;
+
+    /**
+     * @desc Handles the leave event for a user, can occur when a user disconnects or leaves a channel, use this to clean up any resources
+     * @param callback - The callback to execute when a user leaves
+     */
+    public onLeave (callback: LeaveCallback): void;
 }
 
 declare class PondSocket {