Class static side 'typeof Emitter' incorrectly extends base class static side 'typeof EventEmitter'

[moltar]

Describe the Bug

When building the project with TS, I get the following error:

node_modules/cloudevents/dist/transport/emitter.d.ts:48:22 - error TS2417: Class static side 'typeof Emitter' incorrectly extends base class static side 'typeof EventEmitter'.
  Types of property 'on' are incompatible.
    Type '(event: "newListener" | "removeListener" | "cloudevent", listener: (...args: any[]) => void) => void' is not assignable to type '(emitter: EventEmitter, event: string) => AsyncIterableIterator<any>'.
      Types of parameters 'event' and 'emitter' are incompatible.
        Type 'EventEmitter' is not assignable to type '"newListener" | "removeListener" | "cloudevent"'.
          Type 'EventEmitter' is not assignable to type '"cloudevent"'.

48 export declare class Emitter extends EventEmitter {
                       ~~~~~~~

    "cloudevents": "4.0.0",
    "@types/node": "14.14.27",
    "typescript": "4.1.3"

Steps to Reproduce

N/A

Expected Behavior

Build passing.

Additional context

    "cloudevents": "4.0.0",
    "@types/node": "14.14.27",
    "typescript": "4.1.3"

[lance]

Hi @moltar if you could provide some steps to reproduce this, that would be great! Looking at the typescript example in this repository, I do not see this problem. Thanks. :)

[moltar]

Yup, here you go:

https://github.com/moltar/cloudevents-exp

Thanks!

[hilfor]

+1

[mnesbitt]

I'm having this issue as well in version 4.0.0.

I did some testing and it looks like it's caused by the version of @types/node being used. The typescript example in this repository is using @types/[email protected] which is 3 years old. I'm currently using @types/[email protected] and seeing the issue, and @moltar 's example is using 14.14 as well.

I downgraded to [email protected] for now and it's compiling for me with the latest @types/node.

[lance]

@mnesbitt thanks for that info. I'll take a look.

[lance]

@mnesbitt @moltar @hilfor if you all have an opportunity to test this change in your project and provide feedback, that would be appreciated. Thanks!

[moltar]

@lance can we get a pre-release or an alpha channel release? It's not easy to test this, because the code needs to be transpiled to be recognized by NPM.

I installed it from the PR:

npm install cloudevents/sdk-javascript#pull/387/head

But the dir does not have the packaged files:

❯ tree node_modules/cloudevents
node_modules/cloudevents
├── CHANGELOG.md
├── LICENSE
├── README.md
└── package.json

[moltar]

Reference: https://github.com/danillouz/til-npm-release-channels

[lance]

@moltar thanks for bringing this up.

Given that this is a community repo with established processes, we'll need to discuss it. But I think it is a good suggestion. I've opened an issue to track this #388.