@eleven-am/pondsocket 0.1.213 → 0.1.215

package/contexts/eventContext.js

@@ -10,90 +10,46 @@ 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 _EventContext_instances, _EventContext_event, _EventContext_requestId, _EventContext_sendMessage;
+var _EventContext_event, _EventContext_requestId;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventContext = void 0;
 const pondsocket_common_1 = require("@eleven-am/pondsocket-common");
 const baseContext_1 = require("./baseContext");
-/**
- * EventContext combines the functionality of EventRequest and EventResponse
- * to provide a unified interface for handling events in a channel.
- */
 class EventContext extends baseContext_1.BaseContext {
     constructor(event, params, engine) {
         super(engine, params, event.event, event.payload, event.sender);
-        _EventContext_instances.add(this);
         _EventContext_event.set(this, void 0);
         _EventContext_requestId.set(this, void 0);
         __classPrivateFieldSet(this, _EventContext_event, event, "f");
         __classPrivateFieldSet(this, _EventContext_requestId, event.requestId, "f");
     }
-    /**
-     * Assigns data to the client
-     */
     assign(assigns) {
         this.channel.updateAssigns(__classPrivateFieldGet(this, _EventContext_event, "f").sender, assigns);
         return this;
     }
-    /**
-     * Sends a direct reply to the client
-     */
     reply(event, payload) {
         this.engine.sendMessage(pondsocket_common_1.SystemSender.CHANNEL, [__classPrivateFieldGet(this, _EventContext_event, "f").sender], pondsocket_common_1.ServerActions.SYSTEM, event, payload, __classPrivateFieldGet(this, _EventContext_requestId, "f"));
         return this;
     }
-    /**
-     * Broadcasts a message to all users in the channel
-     */
-    broadcast(event, payload) {
-        __classPrivateFieldGet(this, _EventContext_instances, "m", _EventContext_sendMessage).call(this, pondsocket_common_1.ChannelReceiver.ALL_USERS, event, payload);
-        return this;
-    }
-    /**
-     * Broadcasts a message to all users except the sender
-     */
-    broadcastFrom(event, payload) {
-        __classPrivateFieldGet(this, _EventContext_instances, "m", _EventContext_sendMessage).call(this, pondsocket_common_1.ChannelReceiver.ALL_EXCEPT_SENDER, event, payload);
-        return this;
-    }
-    /**
-     * Broadcasts a message to specific users
-     */
-    broadcastTo(event, payload, userIds) {
-        const ids = Array.isArray(userIds) ? userIds : [userIds];
-        __classPrivateFieldGet(this, _EventContext_instances, "m", _EventContext_sendMessage).call(this, ids, event, payload);
-        return this;
-    }
-    /**
-     * Tracks a user's presence
-     */
     trackPresence(presence, userId = __classPrivateFieldGet(this, _EventContext_event, "f").sender) {
         this.channel.trackPresence(userId, presence);
         return this;
     }
-    /**
-     * Updates a user's presence
-     */
     updatePresence(presence, userId = __classPrivateFieldGet(this, _EventContext_event, "f").sender) {
         this.channel.updatePresence(userId, presence);
         return this;
     }
-    /**
-     * Kicks a user from the channel
-     */
     evictUser(reason, userId = __classPrivateFieldGet(this, _EventContext_event, "f").sender) {
         this.channel.evictUser(userId, reason);
         return this;
     }
-    /**
-     * Removes a user's presence
-     */
     removePresence(userId = __classPrivateFieldGet(this, _EventContext_event, "f").sender) {
         this.channel.removePresence(userId);
         return this;
     }
+    _sendMessageToRecipients(recipient, event, payload) {
+        this.engine.sendMessage(__classPrivateFieldGet(this, _EventContext_event, "f").sender, recipient, pondsocket_common_1.ServerActions.BROADCAST, event, payload, __classPrivateFieldGet(this, _EventContext_requestId, "f"));
+    }
 }
 exports.EventContext = EventContext;
-_EventContext_event = new WeakMap(), _EventContext_requestId = new WeakMap(), _EventContext_instances = new WeakSet(), _EventContext_sendMessage = function _EventContext_sendMessage(recipient, event, payload) {
-    this.engine.sendMessage(__classPrivateFieldGet(this, _EventContext_event, "f").sender, recipient, pondsocket_common_1.ServerActions.BROADCAST, event, payload, __classPrivateFieldGet(this, _EventContext_requestId, "f"));
-};
+_EventContext_event = new WeakMap(), _EventContext_requestId = new WeakMap();

package/contexts/joinContext.d.ts

@@ -0,0 +1,17 @@
+import { ChannelReceivers, JoinParams, PondAssigns, PondMessage, PondObject, PondPresence, UserData } from '@eleven-am/pondsocket-common';
+import { BaseContext } from './baseContext';
+import { JoinRequestOptions, RequestCache } from '../abstracts/types';
+import { ChannelEngine } from '../engines/channelEngine';
+export declare class JoinContext<Path extends string> extends BaseContext<Path> {
+    #private;
+    constructor(options: JoinRequestOptions<Path>, engine: ChannelEngine, user: RequestCache);
+    get user(): UserData;
+    get joinParams(): JoinParams;
+    get hasResponded(): boolean;
+    accept(): JoinContext<Path>;
+    decline(message?: string, errorCode?: number): JoinContext<Path>;
+    assign(assigns: PondAssigns): JoinContext<Path>;
+    reply(event: string, payload: PondMessage): JoinContext<Path>;
+    trackPresence(presence: PondPresence): JoinContext<Path>;
+    protected _sendMessageToRecipients(recipient: ChannelReceivers, event: string, payload: PondObject): void;
+}

package/contexts/joinContext.js

@@ -10,16 +10,12 @@ 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 _JoinContext_instances, _JoinContext_options, _JoinContext_user, _JoinContext_newAssigns, _JoinContext_executed, _JoinContext_accepted, _JoinContext_sendMessage, _JoinContext_directMessage, _JoinContext_performChecks;
+var _JoinContext_instances, _JoinContext_options, _JoinContext_user, _JoinContext_newAssigns, _JoinContext_executed, _JoinContext_accepted, _JoinContext_directMessage, _JoinContext_performChecks;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JoinContext = void 0;
 const pondsocket_common_1 = require("@eleven-am/pondsocket-common");
 const baseContext_1 = require("./baseContext");
 const httpError_1 = require("../errors/httpError");
-/**
- * JoinContext combines the functionality of JoinRequest and JoinResponse
- * to provide a unified interface for handling join events in a channel.
- */
 class JoinContext extends baseContext_1.BaseContext {
     constructor(options, engine, user) {
         super(engine, options.params, engine.name, options.joinParams, user.clientId);
@@ -35,9 +31,6 @@ class JoinContext extends baseContext_1.BaseContext {
         __classPrivateFieldSet(this, _JoinContext_accepted, false, "f");
         __classPrivateFieldSet(this, _JoinContext_newAssigns, Object.assign({}, user.assigns), "f");
     }
-    /**
-     * The user who sent the request
-     */
     get user() {
         return {
             id: __classPrivateFieldGet(this, _JoinContext_options, "f").clientId,
@@ -45,21 +38,12 @@ class JoinContext extends baseContext_1.BaseContext {
             presence: {},
         };
     }
-    /**
-     * The join parameters
-     */
     get joinParams() {
         return __classPrivateFieldGet(this, _JoinContext_options, "f").joinParams;
     }
-    /**
-     * Whether the request has been handled
-     */
     get hasResponded() {
         return __classPrivateFieldGet(this, _JoinContext_executed, "f");
     }
-    /**
-     * Accepts the join request
-     */
     accept() {
         __classPrivateFieldGet(this, _JoinContext_instances, "m", _JoinContext_performChecks).call(this);
         const onMessage = this.engine.parent.parent.sendMessage.bind(this.engine.parent.parent, __classPrivateFieldGet(this, _JoinContext_user, "f").socket);
@@ -68,9 +52,6 @@ class JoinContext extends baseContext_1.BaseContext {
         __classPrivateFieldSet(this, _JoinContext_accepted, true, "f");
         return this;
     }
-    /**
-     * Declines the join request
-     */
     decline(message, errorCode) {
         __classPrivateFieldGet(this, _JoinContext_instances, "m", _JoinContext_performChecks).call(this);
         const errorMessage = {
@@ -86,9 +67,6 @@ class JoinContext extends baseContext_1.BaseContext {
         __classPrivateFieldGet(this, _JoinContext_instances, "m", _JoinContext_directMessage).call(this, errorMessage);
         return this;
     }
-    /**
-     * Assigns data to the user
-     */
     assign(assigns) {
         if (__classPrivateFieldGet(this, _JoinContext_accepted, "f")) {
             this.engine.updateAssigns(__classPrivateFieldGet(this, _JoinContext_user, "f").clientId, assigns);
@@ -98,9 +76,6 @@ class JoinContext extends baseContext_1.BaseContext {
         }
         return this;
     }
-    /**
-     * Sends a direct reply to the user
-     */
     reply(event, payload) {
         const message = {
             action: pondsocket_common_1.ServerActions.SYSTEM,
@@ -112,40 +87,16 @@ class JoinContext extends baseContext_1.BaseContext {
         __classPrivateFieldGet(this, _JoinContext_instances, "m", _JoinContext_directMessage).call(this, message);
         return this;
     }
-    /**
-     * Broadcasts a message to specific users
-     */
-    broadcastTo(event, payload, userIds) {
-        const ids = Array.isArray(userIds) ? userIds : [userIds];
-        __classPrivateFieldGet(this, _JoinContext_instances, "m", _JoinContext_sendMessage).call(this, ids, event, payload);
-        return this;
-    }
-    /**
-     * Broadcasts a message to all users in the channel
-     */
-    broadcast(event, payload) {
-        __classPrivateFieldGet(this, _JoinContext_instances, "m", _JoinContext_sendMessage).call(this, pondsocket_common_1.ChannelReceiver.ALL_USERS, event, payload);
-        return this;
-    }
-    /**
-     * Broadcasts a message to all users except the sender
-     */
-    broadcastFrom(event, payload) {
-        __classPrivateFieldGet(this, _JoinContext_instances, "m", _JoinContext_sendMessage).call(this, pondsocket_common_1.ChannelReceiver.ALL_EXCEPT_SENDER, event, payload);
-        return this;
-    }
-    /**
-     * Tracks the user's presence
-     */
     trackPresence(presence) {
         this.engine.trackPresence(__classPrivateFieldGet(this, _JoinContext_user, "f").clientId, presence);
         return this;
     }
+    _sendMessageToRecipients(recipient, event, payload) {
+        this.engine.sendMessage(__classPrivateFieldGet(this, _JoinContext_user, "f").clientId, recipient, pondsocket_common_1.ServerActions.BROADCAST, event, payload, __classPrivateFieldGet(this, _JoinContext_user, "f").requestId);
+    }
 }
 exports.JoinContext = JoinContext;
-_JoinContext_options = new WeakMap(), _JoinContext_user = new WeakMap(), _JoinContext_newAssigns = new WeakMap(), _JoinContext_executed = new WeakMap(), _JoinContext_accepted = new WeakMap(), _JoinContext_instances = new WeakSet(), _JoinContext_sendMessage = function _JoinContext_sendMessage(recipient, event, payload) {
-    this.engine.sendMessage(__classPrivateFieldGet(this, _JoinContext_user, "f").clientId, recipient, pondsocket_common_1.ServerActions.BROADCAST, event, payload, __classPrivateFieldGet(this, _JoinContext_user, "f").requestId);
-}, _JoinContext_directMessage = function _JoinContext_directMessage(event) {
+_JoinContext_options = new WeakMap(), _JoinContext_user = new WeakMap(), _JoinContext_newAssigns = new WeakMap(), _JoinContext_executed = new WeakMap(), _JoinContext_accepted = new WeakMap(), _JoinContext_instances = new WeakSet(), _JoinContext_directMessage = function _JoinContext_directMessage(event) {
     this.engine.parent.parent.sendMessage(__classPrivateFieldGet(this, _JoinContext_user, "f").socket, event);
 }, _JoinContext_performChecks = function _JoinContext_performChecks() {
     if (__classPrivateFieldGet(this, _JoinContext_executed, "f")) {

package/contexts/outgoingContext.d.ts

@@ -0,0 +1,28 @@
+import { ChannelReceivers, Event, EventParams, PondMessage, PondObject } from '@eleven-am/pondsocket-common';
+import { BaseContext } from './baseContext';
+import { ChannelEngine } from '../engines/channelEngine';
+export declare class OutgoingContext<Path extends string> extends BaseContext<Path> {
+    #private;
+    constructor(event: Event, params: EventParams<Path>, engine: ChannelEngine, userid: string);
+    get payload(): PondMessage;
+    /**
+     * Blocks the outgoing context, preventing further processing of the event.
+     */
+    block(): this;
+    /**
+     * Checks if the outgoing context is blocked.
+     * @returns {boolean} - True if blocked, false otherwise.
+     */
+    isBlocked(): boolean;
+    /**
+     * Transforms the outgoing context with a new payload.
+     * @param payload - The new payload to set for the context.
+     */
+    transform(payload: PondMessage): this;
+    /**
+     * Updates the parameters of the outgoing context.
+     * @param params - The new parameters to set for the context.
+     */
+    updateParams(params: EventParams<Path>): void;
+    protected _sendMessageToRecipients(_recipient: ChannelReceivers, _event: string, _payload: PondObject): void;
+}

package/contexts/outgoingContext.js

@@ -54,6 +54,9 @@ class OutgoingContext extends baseContext_1.BaseContext {
     updateParams(params) {
         super.updateParams(params);
     }
+    _sendMessageToRecipients(_recipient, _event, _payload) {
+        void 0;
+    }
 }
 exports.OutgoingContext = OutgoingContext;
 _OutgoingContext_payload = new WeakMap(), _OutgoingContext_isBlocked = new WeakMap();

package/engines/channelEngine.d.ts

@@ -0,0 +1,26 @@
+import { ChannelEvent, ChannelReceivers, ClientMessage, PondAssigns, PondMessage, PondPresence, ServerActions, Unsubscribe, UserAssigns, UserData, UserPresences } from '@eleven-am/pondsocket-common';
+import { LobbyEngine } from './lobbyEngine';
+import { type ChannelSenders } from '../abstracts/types';
+import { type IDistributedBackend } from '../types';
+export declare class ChannelEngine {
+    #private;
+    parent: LobbyEngine;
+    constructor(parent: LobbyEngine, name: string, backend?: IDistributedBackend | null);
+    get name(): string;
+    get users(): Set<string>;
+    addUser(userId: string, assigns: PondAssigns, onMessage: (event: ChannelEvent) => void): Unsubscribe;
+    sendMessage(sender: ChannelSenders, recipient: ChannelReceivers, action: ServerActions, event: string, payload: PondMessage, requestId?: string): void;
+    broadcastMessage(userId: string, message: ClientMessage): void;
+    trackPresence(userId: string, presence: PondPresence): void;
+    updatePresence(userId: string, presence: PondPresence): void;
+    removePresence(userId: string): void;
+    upsertPresence(userId: string, presence: PondPresence): void;
+    updateAssigns(userId: string, assigns: PondMessage): void;
+    kickUser(userId: string, reason: string): void;
+    getAssigns(): UserAssigns;
+    getPresence(): UserPresences;
+    destroy(reason?: string): void;
+    removeUser(userId: string, skipDistributedBroadcast?: boolean): void;
+    getUserData(userId: string): UserData;
+    close(): void;
+}