Missing type definitions for PresenceChannel

[JonathanGuo]

• Echo Version: 1.11.0
• Laravel Version: 8.49.2
• PHP Version: 8.0.6
• NPM Version: 6.14.8
• Node Version: 14.15.1

Description:

First of all, thanks for the great work of the laravel-echo package!

I've noticed the type definition of PresenceChannel is incorrect. (it might be out of date).

According to the interface PresenceChannel it has only 3 functions:

/**
 * This interface represents a presence channel.
 */
export interface PresenceChannel {
    /**
     * Register a callback to be called anytime the member list changes.
     */
    here(callback: Function): PresenceChannel;

    /**
     * Listen for someone joining the channel.
     */
    joining(callback: Function): PresenceChannel;

    /**
     * Listen for someone leaving the channel.
     */
    leaving(callback: Function): PresenceChannel;
}

However, the PusherPresenceChannel extends PusherChannel, which has more functions. e.g. listen

Functionally it's working fine with compiled JavaScript package, but with the @typescript-eslint rule no-unsafe-call rule turned on, we will get the warning/error (depends on config) messages:

Unsafe call of an `any` typed value.eslint@typescript-eslint/no-unsafe-call

And the following error from ts:

Property 'listen' does not exist on type 'PresenceChannel'.ts(2339)

Unfortunately, we cannot even cast the type because the types/interfaces do not overlap:

(Echo.join(channelName) as Channel).listen() // Would throw the following error

// Conversion of type 'PresenceChannel' to type 'Channel' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first.
// Type 'PresenceChannel' is missing the following properties from type 'Channel': options, listen, listenForWhisper, notification, and 4 more.ts(2352)

🚑 Hotfix

To who has similar issues and seek a workaround, use double-cast can be a quick way:

(Echo.join(channelName) as unknown as Channel).listen() 

Steps To Reproduce:

1. Turn on the rule @typescript-eslint/no-unsafe-call
2. Chain the presence channel: Echo.join(channelName).listen(() => {});

---

I am more than happy to submit a PR to fix the interface definitions. Please let me know if the issue I raised is on the right track.

[driesvints]

I don't really see an issue here, sorry. A presence doesn't needs all these methods. They're defined on the base Channel class.

[JonathanGuo]

I don't really see an issue here, sorry. A presence doesn't needs all these methods. They're defined on the base Channel class.

Hi @driesvints . Surely the errors exist in TypeScript. The compiled JavaScript code has the methods, but the PresenceChannel Interface misses the definition of the methods.

The following examples are created in this repo:

First, it doesn't have a type hint when using TS:

It has a Property does not exist on Type error when you use listen

Secondly, it cannot be cast to Channel due to the interface doesn't extend anything, they don't overlap the type definitions:

This issue is basically caused by missing type definitions.

Please review.

[driesvints]

It's best you attempt a PR if you think anything is broken here 👍

[JonathanGuo]

It's best you attempt a PR if you think anything is broken here 👍

Will do