Fix types for the echo library (#403)

* Fix wrong channel types * Add generic types * Throw an error when attempting to use encrypted channels with socket.io * Fix types for the function broadcaster * Add generic to channel types * Fix function types * Make connectors generic * Remove new keyword for function broadcasters * Fix tests * Specify return type for function broadcasters * Clean up generics * Remove unnecessary cast * Update quotes * Use NullChannel return type explicitly
laravel · Nov 3, 2024 · e8491aa · e8491aa
1 parent 1d4bef1
commit e8491aa
Show file tree

Hide file tree

Showing 20 changed files with 157 additions and 86 deletions.
diff --git a/src/channel/channel.ts b/src/channel/channel.ts
@@ -10,41 +10,41 @@ export abstract class Channel {
     /**
      * Listen for an event on the channel instance.
      */
-    abstract listen(event: string, callback: Function): Channel;
+    abstract listen(event: string, callback: Function): this;
 
     /**
      * Listen for a whisper event on the channel instance.
      */
-    listenForWhisper(event: string, callback: Function): Channel {
+    listenForWhisper(event: string, callback: Function): this {
         return this.listen('.client-' + event, callback);
     }
 
     /**
      * Listen for an event on the channel instance.
      */
-    notification(callback: Function): Channel {
+    notification(callback: Function): this {
         return this.listen('.Illuminate\\Notifications\\Events\\BroadcastNotificationCreated', callback);
     }
 
     /**
      * Stop listening to an event on the channel instance.
      */
-    abstract stopListening(event: string, callback?: Function): Channel;
+    abstract stopListening(event: string, callback?: Function): this;
 
     /**
      * Stop listening for a whisper event on the channel instance.
      */
-    stopListeningForWhisper(event: string, callback?: Function): Channel {
+    stopListeningForWhisper(event: string, callback?: Function): this {
         return this.stopListening('.client-' + event, callback);
     }
 
     /**
      * Register a callback to be called anytime a subscription succeeds.
      */
-    abstract subscribed(callback: Function): Channel;
+    abstract subscribed(callback: Function): this;
 
     /**
      * Register a callback to be called anytime an error occurs.
      */
-    abstract error(callback: Function): Channel;
+    abstract error(callback: Function): this;
 }
diff --git a/src/channel/index.ts b/src/channel/index.ts
@@ -9,4 +9,5 @@ export * from './socketio-private-channel';
 export * from './socketio-presence-channel';
 export * from './null-channel';
 export * from './null-private-channel';
+export * from './null-encrypted-private-channel';
 export * from './null-presence-channel';
diff --git a/src/channel/null-channel.ts b/src/channel/null-channel.ts
@@ -21,42 +21,42 @@ export class NullChannel extends Channel {
     /**
      * Listen for an event on the channel instance.
      */
-    listen(event: string, callback: Function): NullChannel {
+    listen(event: string, callback: Function): this {
         return this;
     }
 
     /**
      * Listen for all events on the channel instance.
      */
-    listenToAll(callback: Function): NullChannel {
+    listenToAll(callback: Function): this {
         return this;
     }
 
     /**
      * Stop listening for an event on the channel instance.
      */
-    stopListening(event: string, callback?: Function): NullChannel {
+    stopListening(event: string, callback?: Function): this {
         return this;
     }
 
     /**
      * Register a callback to be called anytime a subscription succeeds.
      */
-    subscribed(callback: Function): NullChannel {
+    subscribed(callback: Function): this {
         return this;
     }
 
     /**
      * Register a callback to be called anytime an error occurs.
      */
-    error(callback: Function): NullChannel {
+    error(callback: Function): this {
         return this;
     }
 
     /**
      * Bind a channel to an event.
      */
-    on(event: string, callback: Function): NullChannel {
+    on(event: string, callback: Function): this {
         return this;
     }
 }
diff --git a/src/channel/null-encrypted-private-channel.ts b/src/channel/null-encrypted-private-channel.ts
@@ -0,0 +1,13 @@
+import { NullChannel } from './null-channel';
+
+/**
+ * This class represents a null private channel.
+ */
+export class NullEncryptedPrivateChannel extends NullChannel {
+    /**
+     * Send a whisper event to other clients in the channel.
+     */
+    whisper(eventName: string, data: any): this {
+        return this;
+    }
+}
diff --git a/src/channel/null-presence-channel.ts b/src/channel/null-presence-channel.ts
@@ -1,35 +1,35 @@
-import { NullChannel } from './null-channel';
+import { NullPrivateChannel } from './null-private-channel';
 import { PresenceChannel } from './presence-channel';
 
 /**
  * This class represents a null presence channel.
  */
-export class NullPresenceChannel extends NullChannel implements PresenceChannel {
+export class NullPresenceChannel extends NullPrivateChannel implements PresenceChannel {
     /**
      * Register a callback to be called anytime the member list changes.
      */
-    here(callback: Function): NullPresenceChannel {
+    here(callback: Function): this {
         return this;
     }
 
     /**
      * Listen for someone joining the channel.
      */
-    joining(callback: Function): NullPresenceChannel {
+    joining(callback: Function): this {
         return this;
     }
 
     /**
      * Send a whisper event to other clients in the channel.
      */
-    whisper(eventName: string, data: any): NullPresenceChannel {
+    whisper(eventName: string, data: any): this {
         return this;
     }
 
     /**
      * Listen for someone leaving the channel.
      */
-    leaving(callback: Function): NullPresenceChannel {
+    leaving(callback: Function): this {
         return this;
     }
 }
diff --git a/src/channel/null-private-channel.ts b/src/channel/null-private-channel.ts
@@ -7,7 +7,7 @@ export class NullPrivateChannel extends NullChannel {
     /**
      * Send a whisper event to other clients in the channel.
      */
-    whisper(eventName: string, data: any): NullPrivateChannel {
+    whisper(eventName: string, data: any): this {
         return this;
     }
 }
diff --git a/src/channel/presence-channel.ts b/src/channel/presence-channel.ts
@@ -7,20 +7,20 @@ export interface PresenceChannel extends Channel {
     /**
      * Register a callback to be called anytime the member list changes.
      */
-    here(callback: Function): PresenceChannel;
+    here(callback: Function): this;
 
     /**
      * Listen for someone joining the channel.
      */
-    joining(callback: Function): PresenceChannel;
+    joining(callback: Function): this;
 
     /**
      * Send a whisper event to other clients in the channel.
      */
-    whisper(eventName: string, data: any): PresenceChannel;
+    whisper(eventName: string, data: any): this;
 
     /**
      * Listen for someone leaving the channel.
      */
-    leaving(callback: Function): PresenceChannel;
+    leaving(callback: Function): this;
 }
diff --git a/src/channel/pusher-channel.ts b/src/channel/pusher-channel.ts
@@ -61,7 +61,7 @@ export class PusherChannel extends Channel {
     /**
      * Listen for an event on the channel instance.
      */
-    listen(event: string, callback: Function): PusherChannel {
+    listen(event: string, callback: Function): this {
         this.on(this.eventFormatter.format(event), callback);
 
         return this;
@@ -70,7 +70,7 @@ export class PusherChannel extends Channel {
     /**
      * Listen for all events on the channel instance.
      */
-    listenToAll(callback: Function): PusherChannel {
+    listenToAll(callback: Function): this {
         this.subscription.bind_global((event, data) => {
             if (event.startsWith('pusher:')) {
                 return;
@@ -89,7 +89,7 @@ export class PusherChannel extends Channel {
     /**
      * Stop listening for an event on the channel instance.
      */
-    stopListening(event: string, callback?: Function): PusherChannel {
+    stopListening(event: string, callback?: Function): this {
         if (callback) {
             this.subscription.unbind(this.eventFormatter.format(event), callback);
         } else {
@@ -102,7 +102,7 @@ export class PusherChannel extends Channel {
     /**
      * Stop listening for all events on the channel instance.
      */
-    stopListeningToAll(callback?: Function): PusherChannel {
+    stopListeningToAll(callback?: Function): this {
         if (callback) {
             this.subscription.unbind_global(callback);
         } else {
@@ -115,7 +115,7 @@ export class PusherChannel extends Channel {
     /**
      * Register a callback to be called anytime a subscription succeeds.
      */
-    subscribed(callback: Function): PusherChannel {
+    subscribed(callback: Function): this {
         this.on('pusher:subscription_succeeded', () => {
             callback();
         });
@@ -126,7 +126,7 @@ export class PusherChannel extends Channel {
     /**
      * Register a callback to be called anytime a subscription error occurs.
      */
-    error(callback: Function): PusherChannel {
+    error(callback: Function): this {
         this.on('pusher:subscription_error', (status) => {
             callback(status);
         });
@@ -137,7 +137,7 @@ export class PusherChannel extends Channel {
     /**
      * Bind a channel to an event.
      */
-    on(event: string, callback: Function): PusherChannel {
+    on(event: string, callback: Function): this {
         this.subscription.bind(event, callback);
 
         return this;

diff --git a/src/channel/pusher-encrypted-private-channel.ts b/src/channel/pusher-encrypted-private-channel.ts
@@ -7,7 +7,7 @@ export class PusherEncryptedPrivateChannel extends PusherChannel {
     /**
      * Send a whisper event to other clients in the channel.
      */
-    whisper(eventName: string, data: any): PusherEncryptedPrivateChannel {
+    whisper(eventName: string, data: any): this {
         this.pusher.channels.channels[this.name].trigger(`client-${eventName}`, data);
 
         return this;

diff --git a/src/channel/pusher-presence-channel.ts b/src/channel/pusher-presence-channel.ts
@@ -1,14 +1,14 @@
-import { PusherChannel } from './pusher-channel';
 import { PresenceChannel } from './presence-channel';
+import { PusherPrivateChannel } from './pusher-private-channel';
 
 /**
  * This class represents a Pusher presence channel.
  */
-export class PusherPresenceChannel extends PusherChannel implements PresenceChannel {
+export class PusherPresenceChannel extends PusherPrivateChannel implements PresenceChannel {
     /**
      * Register a callback to be called anytime the member list changes.
      */
-    here(callback: Function): PusherPresenceChannel {
+    here(callback: Function): this {
         this.on('pusher:subscription_succeeded', (data) => {
             callback(Object.keys(data.members).map((k) => data.members[k]));
         });
@@ -19,7 +19,7 @@ export class PusherPresenceChannel extends PusherChannel implements PresenceChan
     /**
      * Listen for someone joining the channel.
      */
-    joining(callback: Function): PusherPresenceChannel {
+    joining(callback: Function): this {
         this.on('pusher:member_added', (member) => {
             callback(member.info);
         });
@@ -30,7 +30,7 @@ export class PusherPresenceChannel extends PusherChannel implements PresenceChan
     /**
      * Send a whisper event to other clients in the channel.
      */
-    whisper(eventName: string, data: any): PusherPresenceChannel {
+    whisper(eventName: string, data: any): this {
         this.pusher.channels.channels[this.name].trigger(`client-${eventName}`, data);
 
         return this;
@@ -39,7 +39,7 @@ export class PusherPresenceChannel extends PusherChannel implements PresenceChan
     /**
      * Listen for someone leaving the channel.
      */
-    leaving(callback: Function): PusherPresenceChannel {
+    leaving(callback: Function): this {
         this.on('pusher:member_removed', (member) => {
             callback(member.info);
         });

diff --git a/src/channel/pusher-private-channel.ts b/src/channel/pusher-private-channel.ts
@@ -7,7 +7,7 @@ export class PusherPrivateChannel extends PusherChannel {
     /**
      * Send a whisper event to other clients in the channel.
      */
-    whisper(eventName: string, data: any): PusherPrivateChannel {
+    whisper(eventName: string, data: any): this {
         this.pusher.channels.channels[this.name].trigger(`client-${eventName}`, data);
 
         return this;

diff --git a/src/channel/socketio-channel.ts b/src/channel/socketio-channel.ts
@@ -74,7 +74,7 @@ export class SocketIoChannel extends Channel {
     /**
      * Listen for an event on the channel instance.
      */
-    listen(event: string, callback: Function): SocketIoChannel {
+    listen(event: string, callback: Function): this {
         this.on(this.eventFormatter.format(event), callback);
 
         return this;
@@ -83,7 +83,7 @@ export class SocketIoChannel extends Channel {
     /**
      * Stop listening for an event on the channel instance.
      */
-    stopListening(event: string, callback?: Function): SocketIoChannel {
+    stopListening(event: string, callback?: Function): this {
         this.unbindEvent(this.eventFormatter.format(event), callback);
 
         return this;
@@ -92,7 +92,7 @@ export class SocketIoChannel extends Channel {
     /**
      * Register a callback to be called anytime a subscription succeeds.
      */
-    subscribed(callback: Function): SocketIoChannel {
+    subscribed(callback: Function): this {
         this.on('connect', (socket) => {
             callback(socket);
         });
@@ -103,14 +103,14 @@ export class SocketIoChannel extends Channel {
     /**
      * Register a callback to be called anytime an error occurs.
      */
-    error(callback: Function): SocketIoChannel {
+    error(callback: Function): this {
         return this;
     }
 
     /**
      * Bind the channel's socket to an event and store the callback.
      */
-    on(event: string, callback: Function): SocketIoChannel {
+    on(event: string, callback: Function): this {
         this.listeners[event] = this.listeners[event] || [];
 
         if (!this.events[event]) {

diff --git a/src/channel/socketio-presence-channel.ts b/src/channel/socketio-presence-channel.ts
@@ -8,7 +8,7 @@ export class SocketIoPresenceChannel extends SocketIoPrivateChannel implements P
     /**
      * Register a callback to be called anytime the member list changes.
      */
-    here(callback: Function): SocketIoPresenceChannel {
+    here(callback: Function): this {
         this.on('presence:subscribed', (members: any[]) => {
             callback(members.map((m) => m.user_info));
         });
@@ -19,7 +19,7 @@ export class SocketIoPresenceChannel extends SocketIoPrivateChannel implements P
     /**
      * Listen for someone joining the channel.
      */
-    joining(callback: Function): SocketIoPresenceChannel {
+    joining(callback: Function): this {
         this.on('presence:joining', (member) => callback(member.user_info));
 
         return this;
@@ -28,7 +28,7 @@ export class SocketIoPresenceChannel extends SocketIoPrivateChannel implements P
     /**
      * Send a whisper event to other clients in the channel.
      */
-    whisper(eventName: string, data: any): SocketIoPresenceChannel {
+    whisper(eventName: string, data: any): this {
         this.socket.emit('client event', {
             channel: this.name,
             event: `client-${eventName}`,
@@ -41,7 +41,7 @@ export class SocketIoPresenceChannel extends SocketIoPrivateChannel implements P
     /**
      * Listen for someone leaving the channel.
      */
-    leaving(callback: Function): SocketIoPresenceChannel {
+    leaving(callback: Function): this {
         this.on('presence:leaving', (member) => callback(member.user_info));
 
         return this;