[[email protected]] Typescript compilation fails when package is imported

[rryter]

• Version:
  "ipfs-http-client": "52.0.2",

• Platform:
  Ubuntu 20.04

• Subsystem:
  Typescript 4.3.5

Severity:

Critical - Comilation fails as soon as the package is imported.

Description:

node_modules/ipfs-utils/dist/src/files/glob-source.d.ts:10:20
error TS2307: Cannot find module 'ipfs-unixfs/dist/src/types' or its corresponding type declarations.

10     mtime?: import("ipfs-unixfs/dist/src/types").MtimeLike | undefined;

So I checked the package in the node_modules, and there is indeed no dist folder.

Steps to reproduce the error:

npx typescript-starter
npm i ipfs-http-client

1. Create a new file
2. Import the Options Type

import { Options } from 'ipfs-http-client';
export interface InterfaceName {
  options: Options;
}

3. Try to compile.

Workaround

Add postinstall to the scripts in your npm package:

"postinstall": "npm run generate-types && cd node_modules/ipfs-unixfs && npm i --production"

[welcome]

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review.
In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additional round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment.
Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

• "Priority" labels will show how urgent this is for the team.
• "Status" labels will show if this is ready to be worked on, blocked, or in progress.
• "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.io if you just need general support.

[achingbrain]

Looks like ipfs-utils needed it's types rebuilding with the new ESM version of ipfs-unixfs since the internal paths have changed.

This should be fixed by [email protected], just released - can you please delete your node_modules folder and reinstall, you should get the new version then.

[rryter]

It works. Thanks a lot. 🚀

[slwhitman]

I could not get workaround to work. Core error still exists. The import path is incorrect.

Currently: import("ipfs-unixfs/types/src/types")

Should be: import("ipfs-unixfs/src/types")