@eleven-am/pondsocket 0.1.201 → 0.1.203

package/index.d.ts

@@ -1,3 +1,5 @@
 import { PondSocket } from './types';
 
+export { RedisDistributedBackend } from './types';
+
 export default PondSocket;

package/index.js

@@ -1,4 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisDistributedBackend = void 0;
 const server_1 = require("./server/server");
+var distributor_1 = require("./abstracts/distributor");
+Object.defineProperty(exports, "RedisDistributedBackend", { enumerable: true, get: function () { return distributor_1.RedisDistributedBackend; } });
 exports.default = server_1.PondSocket;

package/package.json

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

package/types.d.ts

@@ -29,6 +29,15 @@ export type LeaveCallback<EventTypes extends PondEventMap = PondEventMap, Presen
 
 export type RequestHandler<Request> = (request: Request) => void | Promise<void>;
 
+export interface RedisDistributedBackendOptions {
+    host?: string;
+    port?: number;
+    password?: string;
+    database?: number;
+    url?: string;
+    keyPrefix?: string;
+}
+
 export interface PondSocketOptions {
     server?: HTTPServer;
     socketServer?: WebSocketServer;
@@ -658,3 +667,28 @@ export class OutgoingContext<
      */
     transform(payload: PondMessage): OutgoingContext<Path, PresenceType, AssignType>;
 }
+
+export declare class RedisDistributedBackend implements IDistributedBackend {
+    constructor(options?: RedisDistributedBackendOptions);
+
+    /**
+     * @desc Gets the subject for subscribing to distributed messages
+     * @param endpointName - The name of the endpoint to subscribe to
+     * @param channelName - The name of the channel to subscribe to
+     * @param message - The message to send
+     */
+    broadcast (endpointName: string, channelName: string, message: DistributedChannelMessage): Promise<void>;
+
+    /**
+     * @desc Cleans up the distributed backend, closing any connections and cleaning up resources
+     */
+    cleanup (): Promise<void>;
+
+    /**
+     * @desc Subscribe to messages for a specific endpoint and channel
+     * @param endpointName - The name of the endpoint to subscribe to
+     * @param channelName - The name of the channel to subscribe to
+     * @param handler - The handler function to call when a message is received
+     */
+    subscribe (endpointName: string, channelName: string, handler: (message: DistributedChannelMessage) => void): Unsubscribe;
+}