@eleven-am/pondsocket 0.1.43 → 0.1.45

package/server/pondChannel/joinResponse.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JoinResponse = void 0;
+const enums_1 = require("../../enums");
 const abstractResponse_1 = require("../abstracts/abstractResponse");
 const channelEngine_1 = require("../channel/channelEngine");
 class JoinResponse extends abstractResponse_1.PondResponse {
@@ -34,7 +35,7 @@ class JoinResponse extends abstractResponse_1.PondResponse {
         this._hasExecuted = true;
         const text = `Request to join channel ${this._engine.name} rejected: ${message || 'Unauthorized request'}`;
         const errorMessage = {
-            event: 'POND_ERROR',
+            event: enums_1.ErrorTypes.UNAUTHORIZED_JOIN_REQUEST,
             payload: {
                 message: text,
                 code: errorCode || 403,
@@ -53,7 +54,7 @@ class JoinResponse extends abstractResponse_1.PondResponse {
      */
     send(event, payload, assigns) {
         this.accept(assigns);
-        this._engine.sendMessage('channel', [this._user.clientId], channelEngine_1.ServerActions.SYSTEM, event, payload);
+        this._engine.sendMessage(enums_1.SystemSender.CHANNEL, [this._user.clientId], channelEngine_1.ServerActions.SYSTEM, event, payload);
         return this;
     }
     /**

package/server/pondChannel/pondChannelResponse.test.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const joinResponse_1 = require("./joinResponse");
+const enums_1 = require("../../enums");
 const channelEngine_1 = require("../channel/channelEngine");
 const channelResponse_test_1 = require("../channel/channelResponse.test");
 const createPondResponse = () => {
@@ -49,7 +50,7 @@ describe('pondChannelResponse', () => {
         expect(channelEngine.getUserData(socket.clientId)).toBeUndefined();
         // also check if the socket was sent a message
         expect(socket.socket.send).toHaveBeenCalledWith(JSON.stringify({
-            event: 'POND_ERROR',
+            event: enums_1.ErrorTypes.UNAUTHORIZED_JOIN_REQUEST,
             payload: {
                 message: 'Request to join channel test rejected: Unauthorized request',
                 code: 403,

package/server/presence/presenceEngine.js

@@ -1,13 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PresenceEngine = exports.PresenceEventTypes = void 0;
+exports.PresenceEngine = void 0;
+const enums_1 = require("../../enums");
 const subjectUtils_1 = require("../utils/subjectUtils");
-var PresenceEventTypes;
-(function (PresenceEventTypes) {
-    PresenceEventTypes["JOIN"] = "JOIN";
-    PresenceEventTypes["LEAVE"] = "LEAVE";
-    PresenceEventTypes["UPDATE"] = "UPDATE";
-})(PresenceEventTypes = exports.PresenceEventTypes || (exports.PresenceEventTypes = {}));
 class PresenceEngine {
     constructor() {
         this._presence = new subjectUtils_1.BehaviorSubject();
@@ -41,7 +36,7 @@ class PresenceEngine {
             this._presenceMap.delete(presenceKey);
             if (this._presenceMap.size > 0) {
                 this._presence.next({
-                    type: PresenceEventTypes.LEAVE,
+                    type: enums_1.PresenceEventTypes.LEAVE,
                     changed: presence,
                     presence: Array.from(this._presenceMap.values()),
                 });
@@ -61,7 +56,7 @@ class PresenceEngine {
         if (oldPresence) {
             this._presenceMap.set(presenceKey, presence);
             this._presence.next({
-                type: PresenceEventTypes.UPDATE,
+                type: enums_1.PresenceEventTypes.UPDATE,
                 changed: Object.assign(Object.assign({}, oldPresence), presence),
                 presence: Array.from(this._presenceMap.values()),
             });
@@ -90,7 +85,7 @@ class PresenceEngine {
         if (!this._presenceMap.has(presenceKey)) {
             this._presenceMap.set(presenceKey, presence);
             this._presence.next({
-                type: PresenceEventTypes.JOIN,
+                type: enums_1.PresenceEventTypes.JOIN,
                 changed: presence,
                 presence: Array.from(this._presenceMap.values()),
             });

package/server/presence/presenceEngine.test.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const presenceEngine_1 = require("./presenceEngine");
+const enums_1 = require("../../enums");
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 describe('PresenceEngine', () => {
     let presenceEngine;
@@ -28,7 +29,7 @@ describe('PresenceEngine', () => {
             // @ts-ignore
             expect(presenceEngine._insertPresence).toHaveBeenCalledWith(presenceKey, presence);
             expect(onPresenceChange).toHaveBeenCalledWith({
-                type: presenceEngine_1.PresenceEventTypes.JOIN,
+                type: enums_1.PresenceEventTypes.JOIN,
                 changed: presence,
                 presence: [presence],
             });
@@ -41,7 +42,7 @@ describe('PresenceEngine', () => {
             // @ts-ignore
             expect(presenceEngine._subscribe).toHaveBeenCalledWith(presenceKey, onPresenceChange);
             expect(onPresenceChange).toHaveBeenCalledWith({
-                type: presenceEngine_1.PresenceEventTypes.JOIN,
+                type: enums_1.PresenceEventTypes.JOIN,
                 changed: presence,
                 presence: [presence],
             });
@@ -63,7 +64,7 @@ describe('PresenceEngine', () => {
             };
             presenceEngine.updatePresence(presenceKey, newPresence);
             expect(onPresenceChange).toHaveBeenCalledWith({
-                type: presenceEngine_1.PresenceEventTypes.UPDATE,
+                type: enums_1.PresenceEventTypes.UPDATE,
                 changed: Object.assign(Object.assign({}, presence), newPresence),
                 presence: [newPresence],
             });
@@ -78,7 +79,7 @@ describe('PresenceEngine', () => {
             presenceEngine.trackPresence('presenceKey2', Object.assign(Object.assign({}, presence), { key: 'presence2' }), onPresenceChange);
             presenceEngine.removePresence(presenceKey);
             expect(onPresenceChange).toHaveBeenCalledWith({
-                type: presenceEngine_1.PresenceEventTypes.LEAVE,
+                type: enums_1.PresenceEventTypes.LEAVE,
                 changed: presence,
                 presence: [
                     Object.assign(Object.assign({}, presence), { key: 'presence2' }),

package/server/server/server.test.js

@@ -16,6 +16,7 @@ const http_1 = require("http");
 const superwstest_1 = __importDefault(require("superwstest"));
 const ws_1 = require("ws");
 const pondSocket_1 = require("./pondSocket");
+const enums_1 = require("../../enums");
 const channelEngine_1 = require("../channel/channelEngine");
 const endpoint_1 = require("../endpoint/endpoint");
 describe('server', () => {
@@ -109,7 +110,7 @@ describe('server', () => {
             .expectUpgrade((res) => expect(res.statusCode).toBe(101))
             .expectJson({
             event: 'testEvent',
-            channelName: 'SERVER',
+            channelName: enums_1.SystemSender.ENDPOINT,
             payload: { test: 'test' },
             action: channelEngine_1.ServerActions.SYSTEM,
         })

package/server/utils/matchPattern.test.js

@@ -61,4 +61,16 @@ describe('BaseClass', () => {
         const unMatchingString = 'pondocket2hello?test=5&test2=6';
         expect(baseClass.parseEvent(pattern, unMatchingString)).toEqual(null);
     });
+    it('should match any string if the path is *', () => {
+        const pattern = '*';
+        const string = 'pondSockethello?test=5&test2=6';
+        expect(baseClass.parseEvent(pattern, string)).toEqual({
+            address: string,
+            params: {},
+            query: {
+                test: '5',
+                test2: '6',
+            },
+        });
+    });
 });

package/server/utils/subjectUtils.js

@@ -40,7 +40,7 @@ class SimpleSubject {
         this._observers.add(observer);
         return () => this._observers.delete(observer);
     }
-    publish(message) {
+    next(message) {
         this._observers.forEach((observer) => observer(message));
     }
 }
@@ -54,9 +54,9 @@ class SimpleBehaviorSubject extends SimpleSubject {
     get value() {
         return this._lastMessage;
     }
-    publish(message) {
+    next(message) {
         this._lastMessage = message;
-        super.publish(message);
+        super.next(message);
     }
     subscribe(observer) {
         if (this._lastMessage) {

package/server/utils/subjectUtils.test.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const subjectUtils_1 = require("./subjectUtils");
+describe('Subject', () => {
+    let testSubject;
+    let observer1;
+    let observer2;
+    beforeEach(() => {
+        testSubject = new subjectUtils_1.Subject();
+        observer1 = jest.fn();
+        observer2 = jest.fn();
+        testSubject.subscribe('observer1', observer1);
+        testSubject.subscribe('observer2', observer2);
+    });
+    afterEach(() => {
+        testSubject.unsubscribe('observer1');
+        testSubject.unsubscribe('observer2');
+    });
+    it('should notify all subscribers when next is called', () => {
+        const message = 10;
+        testSubject.next(message);
+        expect(observer1).toHaveBeenCalledWith(message);
+        expect(observer2).toHaveBeenCalledWith(message);
+    });
+    it('should unsubscribe an observer when unsubscribe is called', () => {
+        const identifier = 'observer1';
+        testSubject.unsubscribe(identifier);
+        expect(testSubject['_observers'].has(identifier)).toBe(false);
+    });
+});
+describe('BehaviorSubject', () => {
+    let testSubject;
+    let observer1;
+    let observer2;
+    beforeEach(() => {
+        testSubject = new subjectUtils_1.BehaviorSubject();
+        observer1 = jest.fn();
+        observer2 = jest.fn();
+        testSubject.subscribe('observer1', observer1);
+        testSubject.subscribe('observer2', observer2);
+    });
+    afterEach(() => {
+        testSubject.unsubscribe('observer1');
+        testSubject.unsubscribe('observer2');
+    });
+    it('should notify all subscribers when next is called', () => {
+        const message = 10;
+        testSubject.next(message);
+        expect(observer1).toHaveBeenCalledWith(message);
+        expect(observer2).toHaveBeenCalledWith(message);
+    });
+    it('should unsubscribe an observer when unsubscribe is called', () => {
+        const identifier = 'observer1';
+        testSubject.unsubscribe(identifier);
+        expect(testSubject['_observers'].has(identifier)).toBe(false);
+    });
+    it('should notify new subscribers with the last message when subscribe is called', () => {
+        const message = 10;
+        testSubject.next(message);
+        const newObserver = jest.fn();
+        testSubject.subscribe('newObserver', newObserver);
+        expect(newObserver).toHaveBeenCalledWith(message);
+    });
+});
+describe('SimpleSubject', () => {
+    let testSubject;
+    let observer1;
+    let observer2;
+    beforeEach(() => {
+        testSubject = new subjectUtils_1.SimpleSubject();
+        observer1 = jest.fn();
+        observer2 = jest.fn();
+        testSubject.subscribe(observer1);
+        testSubject.subscribe(observer2);
+    });
+    afterEach(() => {
+        testSubject.next(0);
+    });
+    it('should notify all subscribers when publish is called', () => {
+        const message = 10;
+        testSubject.next(message);
+        expect(observer1).toHaveBeenCalledWith(message);
+        expect(observer2).toHaveBeenCalledWith(message);
+    });
+    it('should unsubscribe an observer when unsubscribe is called', () => {
+        const unsubscribe = testSubject.subscribe(observer1);
+        unsubscribe();
+        expect(testSubject['_observers'].size).toBe(1);
+    });
+});
+describe('SimpleBehaviorSubject', () => {
+    let testSubject;
+    let observer1;
+    let observer2;
+    beforeEach(() => {
+        testSubject = new subjectUtils_1.SimpleBehaviorSubject(0);
+        observer1 = jest.fn();
+        observer2 = jest.fn();
+        testSubject.subscribe(observer1);
+        testSubject.subscribe(observer2);
+    });
+    afterEach(() => {
+        testSubject.next(0);
+    });
+    it('should notify all subscribers when publish is called', () => {
+        const message = 10;
+        testSubject.next(message);
+        expect(observer1).toHaveBeenCalledWith(message);
+        expect(observer2).toHaveBeenCalledWith(message);
+    });
+    it('should unsubscribe an observer when unsubscribe is called', () => {
+        const unsubscribe = testSubject.subscribe(observer1);
+        unsubscribe();
+        expect(testSubject['_observers'].size).toBe(1);
+    });
+    it('should notify new subscribers with the last message when subscribe is called', () => {
+        const message = 10;
+        testSubject.next(message);
+        const newObserver = jest.fn();
+        testSubject.subscribe(newObserver);
+        expect(newObserver).toHaveBeenCalledWith(message);
+    });
+    it('should return the last message when value is called', () => {
+        const message = 10;
+        testSubject.next(message);
+        expect(testSubject.value).toBe(message);
+    });
+});

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';
+import { ClientActions, PresenceEventTypes, ChannelState } from './enums';
 
 export type PondPath = string | RegExp;
 type NextFunction = () => void;
@@ -140,7 +140,7 @@ export declare class Channel {
      * @desc Monitors the connection state of the channel.
      * @param callback - The callback to call when the connection state changes.
      */
-    public onConnectionChange(callback: (connected: boolean) => void): Unsubscribe;
+    public onConnectionChange(callback: (connected: ChannelState) => void): Unsubscribe;
 
     /**
      * @desc Detects when clients join the channel.
@@ -185,12 +185,7 @@ export declare class Channel {
     /**
      * @desc Gets the current connection state of the channel.
      */
-    public isConnected(): boolean;
-
-    /**
-     * @desc check is the channel has been closed.
-     */
-    public hasClosed(): boolean;
+    public channelState: ChannelState;
 
     /**
      * @desc Gets the current presence of the channel.