@eleven-am/pondsocket 0.1.23 → 0.1.25

package/client/channel.js

@@ -57,6 +57,17 @@ class Channel {
             }
         });
     }
+    /**
+     * @desc Monitors the channel for messages.
+     * @param callback - The callback to call when a message is received.
+     */
+    onMessageEvent(callback) {
+        return this._receiver.subscribe((data) => {
+            if (data.action === enums_1.ServerActions.BROADCAST && data.channelName === this._name) {
+                return callback(data.event, data.payload);
+            }
+        });
+    }
     /**
      * @desc Monitors the connection state of the channel.
      * @param callback - The callback to call when the connection state changes.

package/client.js

@@ -18,7 +18,7 @@ class PondClient {
         if (address.protocol !== 'wss:' && address.protocol !== 'ws:') {
             address.protocol = protocol;
         }
-        this.address = address;
+        this._address = address;
         this._channels = {};
         this._broadcaster = new subjectUtils_1.SimpleSubject();
         this._connectionState = new subjectUtils_1.SimpleBehaviorSubject('CLOSED');
@@ -27,7 +27,7 @@ class PondClient {
      * @desc Connects to the server and returns the socket.
      */
     connect(backoff = 1) {
-        const socket = new WebSocket(this.address.toString());
+        const socket = new WebSocket(this._address.toString());
         socket.onopen = () => {
             this._connectionState.publish('OPEN');
         };

package/index.d.ts

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

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Channel = void 0;
+exports.PondChannel = void 0;
 const pondChannel_1 = require("./server/pondChannel/pondChannel");
-Object.defineProperty(exports, "Channel", { enumerable: true, get: function () { return pondChannel_1.PondChannel; } });
+Object.defineProperty(exports, "PondChannel", { enumerable: true, get: function () { return pondChannel_1.PondChannel; } });
 const pondSocket_1 = require("./server/server/pondSocket");
 exports.default = pondSocket_1.PondSocket;

package/node.d.ts

@@ -0,0 +1,4 @@
+// eslint-disable-next-line import/no-unresolved
+import { PondSocketClient } from './types';
+
+export default PondSocketClient;

package/node.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ws_1 = require("ws");
+const client_1 = __importDefault(require("./client"));
+class PondClient extends client_1.default {
+    /**
+     * @desc Connects to the server and returns the socket.
+     */
+    connect(backoff = 1) {
+        const socket = new ws_1.WebSocket(this._address.toString());
+        socket.onopen = () => {
+            this._connectionState.publish('OPEN');
+        };
+        socket.onmessage = (message) => {
+            const data = JSON.parse(message.data);
+            this._broadcaster.publish(data);
+        };
+        socket.onerror = () => {
+            this._connectionState.publish('CLOSED');
+            setTimeout(() => {
+                this.connect(backoff * 2);
+            }, backoff * 1000);
+        };
+        this._socket = socket;
+    }
+}
+exports.default = PondClient;

package/package.json

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

package/server/endpoint/endpoint.test.js

@@ -14,6 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const superwstest_1 = __importDefault(require("superwstest"));
 const endpoint_1 = require("./endpoint");
+const enums_1 = require("../../enums");
 const pondChannel_1 = require("../pondChannel/pondChannel");
 const pondSocket_1 = require("../server/pondSocket");
 const createPondSocket = () => {
@@ -93,6 +94,7 @@ describe('endpoint', () => {
             .expectJson({
             event: 'Hello',
             channelName: 'SERVER',
+            action: enums_1.ServerActions.SYSTEM,
             payload: {
                 room: 'socket',
             },
@@ -100,6 +102,7 @@ describe('endpoint', () => {
             .expectJson({
             event: 'TEST',
             channelName: 'SERVER',
+            action: enums_1.ServerActions.BROADCAST,
             payload: {
                 message: 'Hello everyone',
             },
@@ -112,6 +115,7 @@ describe('endpoint', () => {
             .expectJson({
             event: 'Hello',
             channelName: 'SERVER',
+            action: enums_1.ServerActions.SYSTEM,
             payload: {
                 room: 'secondSocket',
             },
@@ -119,6 +123,7 @@ describe('endpoint', () => {
             .expectJson({
             event: 'TEST',
             channelName: 'SERVER',
+            action: enums_1.ServerActions.BROADCAST,
             payload: {
                 message: 'Hello everyone',
             },
@@ -134,6 +139,7 @@ describe('endpoint', () => {
             event: 'TEST',
             payload: {},
         };
+        console.log(JSON.stringify(message, null, 2));
         const { socket, server, createPondChannel } = createPondSocket();
         expect(server).toBeDefined();
         const endpoint = socket.createEndpoint('/api/:room', (_, res) => {
@@ -209,6 +215,7 @@ describe('endpoint', () => {
             .expectJson({
             event: 'error',
             channelName: 'ENDPOINT',
+            action: enums_1.ServerActions.ERROR,
             payload: {
                 message: 'GatewayEngine: Channel /socket/socket does not exist',
             },
@@ -254,6 +261,7 @@ describe('endpoint', () => {
             .expectJson({
             event: 'error_channel',
             channelName: '/test/socket',
+            action: enums_1.ServerActions.ERROR,
             payload: {
                 message: 'Unauthorized request',
                 code: 403,
@@ -264,11 +272,13 @@ describe('endpoint', () => {
             payload: {},
             event: 'TEST',
             channelName: '/test/socket',
+            action: enums_1.ServerActions.BROADCAST,
         })
             .sendJson(Object.assign(Object.assign({}, message), { event: 'TEST3', action: endpoint_1.ClientActions.BROADCAST }))
             .expectJson({
             event: 'error_channel',
             channelName: '/test/socket',
+            action: enums_1.ServerActions.ERROR,
             payload: {
                 message: 'choke on my balls',
                 code: 403,
@@ -303,10 +313,10 @@ describe('endpoint', () => {
             .expectUpgrade((res) => expect(res.statusCode).toBe(101))
             .sendJson(message)
             .expectJson({
-            event: 'presence_change',
+            event: enums_1.PresenceEventTypes.JOIN,
             channelName: '/test/socket',
+            action: enums_1.ServerActions.PRESENCE,
             payload: {
-                type: 'join',
                 changed: {
                     status: 'online',
                 },
@@ -346,6 +356,7 @@ describe('endpoint', () => {
             .expectJson({
             event: 'error',
             channelName: 'ENDPOINT',
+            action: enums_1.ServerActions.ERROR,
             payload: {
                 message: 'GatewayEngine: Channel /test/socket does not exist',
             },
@@ -355,6 +366,7 @@ describe('endpoint', () => {
             .expectJson({
             event: 'TEST',
             channelName: '/test/socket',
+            action: enums_1.ServerActions.SYSTEM,
             payload: {
                 test: 'test',
             },
@@ -386,6 +398,7 @@ describe('endpoint', () => {
             .expectJson({
             event: 'TEST',
             channelName: 'SERVER',
+            action: enums_1.ServerActions.SYSTEM,
             payload: {
                 test: 'test',
             },
@@ -397,6 +410,7 @@ describe('endpoint', () => {
             .expectJson({
             event: 'TEST',
             channelName: 'SERVER',
+            action: enums_1.ServerActions.SYSTEM,
             payload: {
                 test: 'test',
             },

package/types.d.ts

@@ -131,6 +131,12 @@ export declare class Channel {
      */
     public onMessage(event: string, callback: (message: PondMessage) => void): Unsubscribe;
 
+    /**
+     * @desc Monitors the channel for messages.
+     * @param callback - The callback to call when a message is received.
+     */
+    public onMessageEvent(callback: (event: string, message: PondMessage) => void): Unsubscribe;
+
     /**
      * @desc Monitors the connection state of the channel.
      * @param callback - The callback to call when the connection state changes.
@@ -182,7 +188,6 @@ export declare class Channel {
      */
     public isConnected(): boolean;
 
-
     /**
      * @desc check is the channel has been closed.
      */
@@ -200,7 +205,7 @@ export declare class Channel {
     public onUsersChange(callback: (users: PondPresence[]) => void): Unsubscribe;
 }
 
-export declare class PondSocketClient {
+declare class PondSocketClient {
     constructor(endpoint: string, params?: Record<string, any>);
 
     /**
@@ -451,14 +456,14 @@ declare class ConnectionResponse {
     send (event: string, payload: PondMessage, assigns?: PondAssigns): void;
 }
 
-export declare class Endpoint {
+declare class Endpoint {
     /**
      * @desc Adds a new PondChannel to this path on this endpoint
      * @param path - The path to add the channel to
      * @param channel - The channel to add
      *
      * @example
-     * endpoint.useChannel('/chat', pondChannelInstance);
+     * endpoint.addChannel('/chat', pondChannelInstance);
      */
     addChannel (path: PondPath, channel: PondChannel): void;
 
@@ -486,7 +491,7 @@ export declare class Endpoint {
     closeConnection (clientIds: string | string[]): void;
 }
 
-export declare class PondSocket {
+declare class PondSocket {
     constructor (server?: HTTPServer, socketServer?: WebSocketServer);
 
     /**
@@ -532,5 +537,4 @@ export declare class PondSocket {
  * @param app - The Express app to be used by the server
  * @constructor
  */
-export declare const PondSocketFromExpress: (app: Express) => PondSocketExpressApp;
-
+declare const PondSocketFromExpress: (app: Express) => PondSocketExpressApp;