@eleven-am/pondsocket 0.1.21 → 0.1.22

package/index.d.ts

@@ -1,3 +1,3 @@
-import { PondSocket, PondChannel as Channel } from './types';
+import { PondSocket } from './types';
+
 export default PondSocket;
-export { Channel };

package/package.json

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

package/server/endpoint/endpoint.js

@@ -23,9 +23,9 @@ class Endpoint {
      * @param channel - The channel to add
      *
      * @example
-     * endpoint.useChannel('/chat', pondChannelInstance);
+     * endpoint.addChannel('/chat', pondChannelInstance);
      */
-    useChannel(path, channel) {
+    addChannel(path, channel) {
         const manager = channel._buildManager();
         this._channels.push({ path,
             manager });

package/server/endpoint/endpoint.test.js

@@ -157,8 +157,8 @@ describe('endpoint', () => {
                 },
             });
         });
-        endpoint.useChannel('/test/:room', testPond);
-        endpoint.useChannel('/socket/:room', socketPond);
+        endpoint.addChannel('/test/:room', testPond);
+        endpoint.addChannel('/socket/:room', socketPond);
         yield (0, superwstest_1.default)(server)
             .ws('/api/socket')
             .expectUpgrade((res) => expect(res.statusCode).toBe(101))
@@ -189,7 +189,7 @@ describe('endpoint', () => {
                 },
             });
         });
-        endpoint.useChannel('/test/:room', testPond);
+        endpoint.addChannel('/test/:room', testPond);
         const message = {
             action: endpoint_1.ClientActions.JOIN_CHANNEL,
             channelName: '/test/socket',
@@ -239,7 +239,7 @@ describe('endpoint', () => {
         channel.onJoinRequest((_, res) => {
             res.accept();
         });
-        endpoint.useChannel('/test/:room', channel);
+        endpoint.addChannel('/test/:room', channel);
         const message = {
             action: endpoint_1.ClientActions.JOIN_CHANNEL,
             channelName: '/test/socket',
@@ -291,7 +291,7 @@ describe('endpoint', () => {
                 status: 'online',
             });
         });
-        endpoint.useChannel('/test/:room', channel);
+        endpoint.addChannel('/test/:room', channel);
         const message = {
             action: endpoint_1.ClientActions.JOIN_CHANNEL,
             channelName: '/test/socket',
@@ -332,7 +332,7 @@ describe('endpoint', () => {
         channel.onJoinRequest((_, res) => {
             res.send('TEST', { test: 'test' });
         });
-        endpoint.useChannel('/test/:room', channel);
+        endpoint.addChannel('/test/:room', channel);
         const message = {
             action: endpoint_1.ClientActions.LEAVE_CHANNEL,
             channelName: '/test/socket',

package/server/pondChannel/pondChannel.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PondChannel = void 0;
 const joinRequest_1 = require("./joinRequest");
 const joinResponse_1 = require("./joinResponse");
+const enums_1 = require("../../enums");
 const middleware_1 = require("../abstracts/middleware");
 const channelEngine_1 = require("../channel/channelEngine");
 class PondChannel {
@@ -17,7 +18,7 @@ class PondChannel {
      * @example
      * const pond = new PondChannelEngine();
      * pond.onJoinRequest((request, response) => {
-     *     if (request.event.assigns.admin)
+     *     if (request.user.assigns.admin)
      *          response.accept();
      *     else
      *         response.reject('You are not an admin', 403);
@@ -33,7 +34,7 @@ class PondChannel {
      * @example
      * pond.onEvent('echo', (request, response) => {
      *     response.send('echo', {
-     *         message: request.payload,
+     *         message: request.event.payload,
      *     });
      * });
      */
@@ -45,6 +46,29 @@ class PondChannel {
             next();
         });
     }
+    /**
+     * @desc Broadcasts a message to all users in a channel
+     * @param event - The event to broadcast
+     * @param payload - The payload to send
+     * @param channelName - The channel to broadcast to (if not specified, broadcast to all channels)
+     * @example
+     * pond.broadcast('echo', {
+     *    message: 'Hello World',
+     *    timestamp: Date.now(),
+     *    channel: 'my_channel',
+     *});
+     */
+    broadcast(event, payload, channelName) {
+        if (channelName) {
+            const channel = this._getChannel(channelName) || this._createChannel(channelName);
+            channel.sendMessage('channel', 'all_users', enums_1.ServerActions.SYSTEM, event, payload);
+        }
+        else {
+            this._channels.forEach((channel) => {
+                channel.sendMessage('channel', 'all_users', enums_1.ServerActions.SYSTEM, event, payload);
+            });
+        }
+    }
     /**
      * @desc Builds a PondChannelManager from the current engine
      */

package/types.d.ts

@@ -5,7 +5,7 @@ import internal from 'stream';
 import { Express } from 'express';
 import { WebSocketServer, WebSocket } from 'ws';
 
-import { ClientActions, PresenceEventTypes } from './enums.d';
+import { ClientActions, PresenceEventTypes } from './enums';
 
 export type PondPath = string | RegExp;
 type NextFunction = () => void;
@@ -392,7 +392,7 @@ declare class PondChannel {
      * @example
      * const pond = new PondChannelEngine();
      * pond.onJoinRequest((request, response) => {
-     *     if (request.event.assigns.admin)
+     *     if (request.user.assigns.admin)
      *          response.accept();
      *     else
      *         response.reject('You are not an admin', 403);
@@ -407,11 +407,25 @@ declare class PondChannel {
      * @example
      * pond.onEvent('echo', (request, response) => {
      *     response.send('echo', {
-     *         message: request.payload,
+     *         message: request.event.payload,
      *     });
      * });
      */
     onEvent (event: PondPath, handler: (request: EventRequest, response: EventResponse) => void | Promise<void>): void;
+
+    /**
+     * @desc Broadcasts a message to all users in a channel
+     * @param event - The event to broadcast
+     * @param payload - The payload to send
+     * @param channelName - The channel to broadcast to (if not specified, broadcast to all channels)
+     * @example
+     * pond.broadcast('echo', {
+     *    message: 'Hello World',
+     *    timestamp: Date.now(),
+     *    channel: 'my_channel',
+     *});
+     */
+    broadcast (event: string, payload: PondMessage, channelName?: string): void;
 }
 
 declare class ConnectionResponse {
@@ -446,7 +460,7 @@ export declare class Endpoint {
      * @example
      * endpoint.useChannel('/chat', pondChannelInstance);
      */
-    useChannel (path: PondPath, channel: PondChannel): void;
+    addChannel (path: PondPath, channel: PondChannel): void;
 
     /**
      * @desc List all clients connected to this endpoint