@eleven-am/pondsocket 0.1.59 → 0.1.61

package/abstracts/abstractRequest.js

@@ -35,7 +35,7 @@ class AbstractRequest {
             payload: __classPrivateFieldGet(this, _AbstractRequest_payload, "f"),
         };
     }
-    get channelNme() {
+    get channelName() {
         return this._engine.name;
     }
     get assigns() {

package/channel/channel.js

@@ -21,9 +21,9 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-var _ChannelEngine_instances, _ChannelEngine_receiver, _ChannelEngine_presenceEngine, _ChannelEngine_users, _ChannelEngine_parentEngine, _ChannelEngine_subscribe, _ChannelEngine_getUsersFromRecipients;
+var _ChannelEngine_instances, _ChannelEngine_receiver, _ChannelEngine_presenceEngine, _ChannelEngine_users, _ChannelEngine_parentEngine, _ChannelEngine_subscribe, _ChannelEngine_getUsersFromRecipients, _Client_engine;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChannelEngine = void 0;
+exports.Client = exports.ChannelEngine = void 0;
 const eventRequest_1 = require("./eventRequest");
 const eventResponse_1 = require("./eventResponse");
 const enums_1 = require("../enums");
@@ -251,3 +251,37 @@ _ChannelEngine_receiver = new WeakMap(), _ChannelEngine_presenceEngine = new Wea
     }
     return users;
 };
+class Client {
+    constructor(engine) {
+        _Client_engine.set(this, void 0);
+        __classPrivateFieldSet(this, _Client_engine, engine, "f");
+    }
+    getAssigns() {
+        return __classPrivateFieldGet(this, _Client_engine, "f").getAssigns();
+    }
+    getUserData(userId) {
+        return __classPrivateFieldGet(this, _Client_engine, "f").getUserData(userId);
+    }
+    broadcastMessage(event, payload) {
+        __classPrivateFieldGet(this, _Client_engine, "f").sendMessage(enums_1.SystemSender.CHANNEL, enums_1.ChannelReceiver.ALL_USERS, enums_1.ServerActions.BROADCAST, event, payload);
+    }
+    sendToUser(userId, event, payload) {
+        __classPrivateFieldGet(this, _Client_engine, "f").sendMessage(enums_1.SystemSender.CHANNEL, [userId], enums_1.ServerActions.BROADCAST, event, payload);
+    }
+    banUser(userId, reason) {
+        __classPrivateFieldGet(this, _Client_engine, "f").kickUser(userId, reason !== null && reason !== void 0 ? reason : 'You have been banned from the channel');
+    }
+    trackPresence(userId, presence) {
+        __classPrivateFieldGet(this, _Client_engine, "f").trackPresence(userId, presence);
+    }
+    removePresence(userId) {
+        var _a;
+        (_a = __classPrivateFieldGet(this, _Client_engine, "f").presenceEngine) === null || _a === void 0 ? void 0 : _a.removePresence(userId);
+    }
+    updatePresence(userId, presence) {
+        var _a;
+        (_a = __classPrivateFieldGet(this, _Client_engine, "f").presenceEngine) === null || _a === void 0 ? void 0 : _a.updatePresence(userId, presence);
+    }
+}
+exports.Client = Client;
+_Client_engine = new WeakMap();

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/joinRequest.js

@@ -14,6 +14,7 @@ var _JoinRequest_params, _JoinRequest_clientId, _JoinRequest_assigns;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JoinRequest = void 0;
 const abstractRequest_1 = require("../abstracts/abstractRequest");
+const channel_1 = require("../channel/channel");
 class JoinRequest extends abstractRequest_1.AbstractRequest {
     constructor(event, params, engine) {
         super(engine.name, engine, params);
@@ -34,6 +35,9 @@ class JoinRequest extends abstractRequest_1.AbstractRequest {
             presence: {},
         };
     }
+    get client() {
+        return new channel_1.Client(this._engine);
+    }
 }
 exports.JoinRequest = JoinRequest;
 _JoinRequest_params = new WeakMap(), _JoinRequest_clientId = new WeakMap(), _JoinRequest_assigns = new WeakMap();

package/package.json

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

package/types.d.ts

@@ -73,7 +73,7 @@ export enum ChannelState {
 declare class AbstractRequest<Path extends string> {
     event: PondEvent<Path>;
 
-    channelNme: string;
+    channelName: string;
 
     assigns: UserAssigns;
 
@@ -106,6 +106,8 @@ declare abstract class PondResponse {
 
 declare class EventRequest<Path extends string> extends AbstractRequest<Path> {
     user: UserData;
+
+    client: Client;
 }
 
 declare class EventResponse extends PondResponse {
@@ -313,10 +315,67 @@ declare class Endpoint {
     closeConnection (clientIds: string | string[]): void;
 }
 
+export declare class Client {
+    /**
+     * @desc Gets the current assign data for the channel.
+     */
+    get getAssigns (): UserAssigns;
+
+    /**
+     * @desc Gets the assign date for a specific user.
+     * @param userId - The id of the user to get the assign data for.
+     */
+    getUserData (userId: string): UserData;
+
+    /**
+     * @desc Broadcasts a message to every client in the channel,
+     * @param event - The event to send.
+     * @param payload - The message to send.
+     */
+    broadcastMessage (event: string, payload: PondMessage): void;
+
+    /**
+     * @desc Sends a message to a specific client in the channel.
+     * @param userId - The id of the user to send the message to.
+     * @param event - The event to send.
+     * @param payload - The message to send.
+     */
+    sendToUser (userId: string, event: string, payload: PondMessage): void;
+
+    /**
+     * @desc Bans a user from the channel.
+     * @param userId - The id of the user to ban.
+     * @param reason - The reason for the ban.
+     */
+    banUser (userId: string, reason?: string): void;
+
+    /**
+     * @desc tracks a user's presence in the channel
+     * @param userId - the id of the user to track
+     * @param presence - the presence of the user
+     */
+    trackPresence (userId: string, presence: PondPresence): void;
+
+    /**
+     * @desc removes a user's presence from the channel
+     * @param userId - the id of the user to remove
+     */
+    removePresence (userId: string): void;
+
+    /**
+     * @desc updates a user's presence in the channel
+     * @param userId - the id of the user to update
+     * @param presence - the new presence of the user
+     */
+    updatePresence (userId: string, presence: PondPresence): void;
+}
+
 declare class JoinRequest<Path extends string> extends AbstractRequest<Path> {
     joinParams: JoinParams;
 
     user: UserData;
+
+    client: Client;
 }
 
 declare class JoinResponse extends PondResponse {