Add type generation from jsdoc

[mpetrunic]

Related to: libp2p/js-libp2p#659

I've fixed some jsdocs to generate better types. There is also some issue with index modules but overall jsdoc seems to be
generating quite good types. A lot of stuff related to protons library is "any" since that library doesn't have types. Not sure from where to import/use all those stream/duplex/DuplexIterable types

Do we wan't some precommit hook to regenerate types?

cc @wemeetagain @tuyennhv you can try from this branch directly

[mpetrunic]

cc @vasco-santos is this proper way to include types?

[vasco-santos]

@mpetrunic The goal is to not have the index.d.ts in the repo. aegir should generate it from the JS docs when we release each module. This way, it is always updated with the current jsdoc. However, it seems that aegir did not release yet the support for it ipfs/aegir#568

@hugomrdias do you have any visibility on when you will be able to go back to the aegir support?

[vasco-santos]

If we do not have support soon for aegir, we can move forward with this as the migration should be as simple as removing the declaration file from the repo and aegir generate it. @mpetrunic let us know once we should review this PR

[hugomrdias]

@mpetrunic The goal is to not have the index.d.ts in the repo. aegir should generate it from the JS docs when we release each module. This way, it is always updated with the current jsdoc. However, it seems that aegir did not release yet the support for it ipfs/aegir#568

@hugomrdias do you have any visibility on when you will be able to go back to the aegir support?

no i don't, it will take a while probably

[mpetrunic]

@vasco-santos
Seems like we can export single type declaration only if we export everything from src/index.js file and use that only. So I changed tsconfig to generate type declaration alongside js sources.

@wemeetagain @tuyennhv
Imports work now, but gossipsub has a lot of duplicated/incompatible types with libp2p-interfaces. We should probably try to port PeerStreams type definition into jsdoc here.

[wemeetagain]

gossipsub has a lot of duplicated/incompatible types with libp2p-interfaces

👍 the types there are meant to be temporary until these types (and js-libp2p core) types are available. Happy to slowly get rid of these libp2p types duplicated everywhere 😂
@tuyennhv has a branch https://github.com/ChainSafe/js-libp2p-gossipsub/compare/tuyen/libp2p-interfaces-types-2 where we can sort this out.

[vasco-santos]

Seems like we can export single type declaration only if we export everything from src/index.js file and use that only. So I changed tsconfig to generate type declaration alongside js sources.

Yeah, that should be because we require specific interfaces

@mpetrunic should I review the PR or should we wait on gossipsub integration before?

[hugomrdias]

@Gozala has taken over the ts jsdocs aegir PRs and is making good progress. Maybe that helps here.

[mpetrunic]

Seems like we can export single type declaration only if we export everything from src/index.js file and use that only. So I changed tsconfig to generate type declaration alongside js sources.

Yeah, that should be because we require specific interfaces

@mpetrunic should I review the PR or should we wait on gossipsub integration before?

@vasco-santos I'm still getting types inline with gossipsub and removing duplicates, so pls wait a bit more before reviewing.

@Gozala has taken over the ts jsdocs aegir PRs and is making good progress. Maybe that helps here.

@hugomrdias We can switch over once it's ready, I'm mostly changing jsdoc to describe types more accurately.

[twoeths]

Confirm that gossipsub works fine with this PR 👍

[mpetrunic]

@vasco-santos we are ready for review :)

[vasco-santos]

Overall this looks good to me. Just minor stuff below

[wemeetagain]

I think this is ready for re-review

[vasco-santos]

LGTM! 🎉

[vasco-santos]

FYI Shipped libp2p-interfaces@0.5.2