@eleven-am/pondsocket 0.1.214 → 0.1.216

package/types.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DistributedMessageType = void 0;
+var DistributedMessageType;
+(function (DistributedMessageType) {
+    DistributedMessageType["STATE_REQUEST"] = "STATE_REQUEST";
+    DistributedMessageType["STATE_RESPONSE"] = "STATE_RESPONSE";
+    DistributedMessageType["USER_JOINED"] = "USER_JOINED";
+    DistributedMessageType["USER_LEFT"] = "USER_LEFT";
+    DistributedMessageType["USER_MESSAGE"] = "USER_MESSAGE";
+    DistributedMessageType["PRESENCE_UPDATE"] = "PRESENCE_UPDATE";
+    DistributedMessageType["PRESENCE_REMOVED"] = "PRESENCE_REMOVED";
+    DistributedMessageType["ASSIGNS_UPDATE"] = "ASSIGNS_UPDATE";
+    DistributedMessageType["EVICT_USER"] = "EVICT_USER";
+    DistributedMessageType["USER_REMOVE"] = "USER_REMOVE";
+    DistributedMessageType["USER_GET_REQUEST"] = "USER_GET_REQUEST";
+    DistributedMessageType["USER_GET_RESPONSE"] = "USER_GET_RESPONSE";
+    DistributedMessageType["NODE_HEARTBEAT"] = "NODE_HEARTBEAT";
+})(DistributedMessageType || (exports.DistributedMessageType = DistributedMessageType = {}));

package/wrappers/channel.d.ts

@@ -0,0 +1,54 @@
+import { PondMessage, PondAssigns, PondPresence } from '@eleven-am/pondsocket-common';
+import { ChannelEngine } from '../engines/channelEngine';
+export declare class Channel {
+    #private;
+    constructor(engine: ChannelEngine);
+    /**
+     * Gets a user's data
+     */
+    getUserData(userId: string): import("@eleven-am/pondsocket-common").UserData<import("@eleven-am/pondsocket-common").PondObject, import("@eleven-am/pondsocket-common").PondObject>;
+    /**
+     * Gets all presence data
+     */
+    getPresences(): import("@eleven-am/pondsocket-common").UserPresences;
+    /**
+     * Gets all assigns data
+     */
+    getAssigns(): import("@eleven-am/pondsocket-common").UserAssigns;
+    /**
+     * Broadcasts a message to all users
+     */
+    broadcast(event: string, payload: PondMessage): this;
+    /**
+     * Broadcasts a message from a specific user to all others
+     */
+    broadcastFrom(userId: string, event: string, payload: PondMessage): this;
+    /**
+     * Broadcasts a message to specific users
+     */
+    broadcastTo(userIds: string | string[], event: string, payload: PondMessage): this;
+    /**
+     * Kicks a user from the channel
+     */
+    evictUser(userId: string, reason?: string): this;
+    /**
+     * Tracks a user's presence
+     */
+    trackPresence(userId: string, presence: PondPresence): this;
+    /**
+     * Updates a user's presence
+     */
+    updatePresence(userId: string, presence: PondPresence): this;
+    /**
+     * Removes a user's presence
+     */
+    removePresence(userId: string): this;
+    /**
+     * Adds or updates a user's presence
+     */
+    upsertPresence(userId: string, presence: PondPresence): this;
+    /**
+     * Updates a user's assigns
+     */
+    updateAssigns(userId: string, assigns: PondAssigns): this;
+}

package/wrappers/endpoint.d.ts

@@ -0,0 +1,10 @@
+import { PondPath } from '@eleven-am/pondsocket-common';
+import { AuthorizationHandler } from '../abstracts/types';
+import { EndpointEngine } from '../engines/endpointEngine';
+export declare class Endpoint {
+    #private;
+    constructor(engine: EndpointEngine);
+    createChannel<Path extends string>(path: PondPath<Path>, handler: AuthorizationHandler<Path>): import("./pondChannel").PondChannel;
+    closeConnection(clientIds: string | string[]): void;
+    getClients(): import("ws").WebSocket[];
+}

package/wrappers/pondChannel.d.ts

@@ -0,0 +1,15 @@
+import { PondMessage, PondPath } from '@eleven-am/pondsocket-common';
+import { Channel } from './channel';
+import { EventHandler, LeaveCallback, OutgoingEventHandler } from '../abstracts/types';
+import { LobbyEngine } from '../engines/lobbyEngine';
+export declare class PondChannel {
+    #private;
+    constructor(lobby: LobbyEngine);
+    onEvent<Event extends string>(event: PondPath<Event>, handler: EventHandler<Event>): PondChannel;
+    onLeave(callback: LeaveCallback): PondChannel;
+    handleOutgoingEvent<Event extends string>(event: PondPath<Event>, handler: OutgoingEventHandler<Event>): this;
+    getChannel(channelName: string): Channel | null;
+    broadcast(channelName: string, event: string, payload: PondMessage): PondChannel;
+    broadcastFrom(channelName: string, userId: string, event: string, payload: PondMessage): PondChannel;
+    broadcastTo(channelName: string, userIds: string | string[], event: string, payload: PondMessage): PondChannel;
+}