`ipfs-unixfs-importer`: `import` type declaration imports `UnixFS` from the wrong location

[mistermoe]

Summary

ipfs-unixfs-importer: import type declaration imports UnixFS from the wrong location

Impact

unable to use ipfs-unixfs-importer package in typescript projects. attempting to transpile typescript project using tsc fails with the following error:

> tsc

node_modules/ipfs-unixfs-importer/types/src/index.d.ts:26:20 - error TS2307: Cannot find module 'ipfs-unixfs/src' or its corresponding type declarations.

26     unixfs: import("ipfs-unixfs/src").UnixFS | undefined;
                      ~~~~~~~~~~~~~~~~~


Found 1 error.

Potential Cause

• typesVersions in package.json of ipfs-unixfs has a path mapping that checks both types/* and types/src/*. Removing typesVersions entirely and regenerating the type declarations yields unixfs: import("ipfs-unixfs").UnixFS | undefined which solves the problem because typescript resolves the type using the types property in package.json. Though, i'm not sure if this is the way we want to solve the problem. I'm not sure whether downstream projects are importing types that aren't exported from index.d.ts. I think ideally, using something like npm-dts to bundle all types into 1 index.d.ts that is made available at the root of the package tarball would remove a lot of complexity around configuring types

Somewhat related

• type declaration files are duplicated in the package
  
• I think that the reset npm script needs to delete the types directory in every package because it's auto-generated. not deleting them prevents types from being regenerated

[mistermoe]

@achingbrain Let me know if there's anything that i can help provide clarity on.

[github-actions]

🎉 This issue has been resolved in version ipfs-unixfs-v6.0.9 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[github-actions]

🎉 This issue has been resolved in version ipfs-unixfs-importer-v9.0.10 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[github-actions]

🎉 This issue has been resolved in version ipfs-unixfs-exporter-v7.0.11 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[mhchu-multiverse]

It looks like this was resolved by removing typesVersions from package.json in commit 465670e but was reintroduced in commit 9fccb7c. Between these two, there have been no published version, so there is currently no version I have found using ipfs-unixfs-importer which compiles with tsc.

[achingbrain]

tsc keeps choosing the wrong type when inferring return types. I think the trick is to specify return types on exported functions, then you get what you expect, whereas when you let the compiler figure it out you frequently get weird frankentypes.