[Types] CIDs typings incompability

[AuHau]

CID version 1.1.0 introduced typings generated with aegir which changed the structure of typings as before this release it was placed in /src/ folder. With version 1.1.4 ts compile now fails with:

node_modules/libp2p/dist/src/content-routing.d.ts:86:19 - error TS2307: Cannot find module 'cids/src/' or its corresponding type declarations.

86 type CID = import("cids/src/");
                     ~~~~~~~~~~~


Found 1 error.

With version 1.0.0 of CID the problem is not present.

[AuHau]

Hmm in the generated typings I see:

type CID = import("cids/src/");

But the original JSDoc import does not have it: https://github.com/libp2p/js-libp2p/blob/master/src/content-routing.js#L12 😳

Maybe it is related to the version of CID that was used when the typings were released? 🤔

[vasco-santos]

Thanks for reporting this @AuHau
We had some regressions with the cids. I will need to have a deeper look into this as the cids/src is strange indeed

In theory, this should work as the cids import goes to module "./libp2p/js-libp2p/node_modules/cids/dist/src/index". However, when the build runs it adds the strange /src part. This might be a problem with typescript declaration files generation.

Any ideas @hugomrdias @Gozala ?

[AuHau]

Sure thing! Just FYI. downgrading cids to 1.0.2 "solved" the problem...

[hugomrdias]

@AuHau which ts version are you using?

[vasco-santos]

@hugomrdias this is one of the cases that the aegir typecheck is not catching errors. If you build libp2p and check /dist/src/content-routing vscode also reports this error. It was not happening before though

[Gozala]

I'm afraid problem is that TS has a bug that incorrectly resolves module paths microsoft/TypeScript#41284. As to why TS rewrites imports to things like cids/src/ I am pretty clueless, but this has came up before & think the most reasonable solution is to workaround TS issues as per ipfs/aegir#703

[ryanio]

I have the same problem here ethereumjs/ethereumjs-monorepo#1027 (comment)

[vmx]

@ryanio thanks for pointing to the PR. It helped me to verify that the fix in js-cid actually works. No workarounds for that should be needed if you use cids v1.1.5.

[vasco-santos]

thanks @vmx and @hugomrdias

@AuHau this should be fixed, feel free to re-open if you have further issues