feat: safe dispatch event

[mpetrunic]

resolves #317

[mpetrunic]

@achingbrain any idea whats going on with lerna/nx?

[tabcat]

is detail the best name for this param?

[mpetrunic]

No idea, its already ref like that in multiple places

[achingbrain]

detail is used in other places as it's the option key from the CustomEvent constructor

[tabcat]

right it seems confusing since this is actually the CustomEvent options object which contains detail

js-libp2p-interfaces/packages/interfaces/src/events.ts

Lines 78 to 79 in 2d7e06b

	safeDispatchEvent<Detail>(type: keyof EventMap, detail: CustomEventInit<Detail>): boolean {
	return this.dispatchEvent(new CustomEvent<Detail>(type as string, detail))

js-libp2p-interfaces/packages/interface-mocks/src/connection-manager.ts

Lines 97 to 99 in 2d7e06b

	this.components.connectionManager?.safeDispatchEvent<Connection>('peer:connect', {
	detail: aToB
	})

[achingbrain]

any idea whats going on with lerna/nx?

Something has shifted in the dependency graph that means nx can't calculate the dependency graph as it trips over this dependency.

That dep version prevents @semantic-release/github hitting request limits when publishing from monorepos with lots of packages like this one - the PR has been open since April!

[achingbrain]

If you remove the package-lock.json file, nx starts to work again 🙄

[achingbrain]

The idea of the typed EventEmitter here is just to be a stopgap until TypeScript adds support for typed emitters. It's supposed to mirror the EventTarget interface.

This PR adds a non-standard method, safeDispatchEvent which stops this being a type-safe drop-in replacement for EventTarget - is there no other way?

[mpetrunic]

The idea of the typed EventEmitter here is just to be a stopgap until TypeScript adds support for typed emitters. It's supposed to mirror the EventTarget interface.

This PR adds a non-standard method, safeDispatchEvent which stops this being a type-safe drop-in replacement for EventTarget - is there no other way?

The idea of the typed EventEmitter here is just to be a stopgap until TypeScript adds support for typed emitters. It's supposed to mirror the EventTarget interface.

This PR adds a non-standard method, safeDispatchEvent which stops this being a type-safe drop-in replacement for EventTarget - is there no other way?

Not unless we override Event.type which is a string and there is no generic to override it.
I tried:

  dispatchEvent<E extends {type: keyof EventMap} & Event>(event: E): boolean {

but it errors since type of CustomEvent we sent there is a string and not key in the map.
We could fix that by using overridden CustomEvent but IMHO this is even more disruptive. Example: https://github.com/mizdra/strictly-typed-event-target/blob/master/src/index.ts#L8

But even if they add typed EventEmitter, we can just remove all other method implementation and leave safeEventDispatch.

[github-actions]

🎉 This PR is included in version @libp2p/interfaces-v3.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version @libp2p/interface-mocks-v9.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀