`Metadata` and `FormatEnum` types are not exported in 0.35

[benmccann]

Possible bug

Is this a possible bug in a feature of sharp, unrelated to installation?

• Running npm install sharp completes without error.
• Running node -e "import 'sharp'" completes without error.

If you cannot confirm both of these, please open an installation issue instead.

Are you using the latest version of sharp?

• I am using the latest version of sharp as reported by npm view sharp dist-tags.latest.

If you cannot confirm this, please upgrade to the latest version and try again before opening an issue.

If you are using another package which depends on a version of sharp that is not the latest, please open an issue against that package instead.

What is the output of running npx envinfo --binaries --system --npmPackages=sharp --npmGlobalPackages=sharp?

  npmPackages:
    sharp: ^0.35.0 => 0.35.1

Does this problem relate to file caching?

The default behaviour of libvips is to cache input files, which can lead to EBUSY or EPERM errors on Windows.
Use sharp.cache(false) to switch this feature off.

• Adding sharp.cache(false) does not fix this problem.

Does this problem relate to images appearing to have been rotated by 90 degrees?

Images that contain EXIF Orientation metadata are not auto-oriented. By default, EXIF metadata is removed.

• To auto-orient pixel values use the parameter-less rotate() operation.

• To retain EXIF Orientation use keepExif().

• Using rotate() or keepExif() does not fix this problem.

What are the steps to reproduce?

What is the expected behaviour?

The Metadata interface should be exported

Please provide a minimal, standalone code sample, without other dependencies, that demonstrates this problem

We use it here:

https://github.com/sveltejs/kit/blob/b42cc23f086afd45ffa4dd714ee838513bacafd1/packages/enhanced-img/src/index.js#L16

It seems it was exported in 0.34 and not in 0.35?

$ pnpm check
$ tsc
../../node_modules/.pnpm/imagetools-core@10.0.0/node_modules/imagetools-core/dist/transforms/format.d.ts:2:15 - error TS2614: Module '"sharp"' has no exported member 'FormatEnum'. Did you mean to use 'import FormatEnum from "sharp"' instead?

2 import type { FormatEnum } from 'sharp';
                ~~~~~~~~~~

../../node_modules/.pnpm/imagetools-core@10.0.0/node_modules/imagetools-core/dist/types.d.ts:1:15 - error TS2614: Module '"sharp"' has no exported member 'Metadata'. Did you mean to use 'import Metadata from "sharp"' instead?

1 import type { Metadata, Sharp } from 'sharp';
                ~~~~~~~~

../../node_modules/.pnpm/vite-imagetools@10.0.1_vite@8.0.10_@types+node@22.19.19_esbuild@0.27.3_jiti@2.4.2_yaml@2.8.3_/node_modules/vite-imagetools/dist/types.d.ts:2:15 - error TS2614: Module '"sharp"' has no exported member 'Metadata'. Did you mean to use 'import Metadata from "sharp"' instead?

2 import type { Metadata } from 'sharp';
                ~~~~~~~~

src/index.js:16:28 - error TS2694: Namespace '"/home/bmccann/src/kit/node_modules/.pnpm/sharp@0.35.1/node_modules/sharp/dist/index"' has no exported member 'Metadata'.

16  * @param {import('sharp').Metadata} meta
                              ~~~~~~~~


Found 4 errors in 4 files.

Errors  Files
     1  ../../node_modules/.pnpm/imagetools-core@10.0.0/node_modules/imagetools-core/dist/transforms/format.d.ts:2
     1  ../../node_modules/.pnpm/imagetools-core@10.0.0/node_modules/imagetools-core/dist/types.d.ts:1
     1  ../../node_modules/.pnpm/vite-imagetools@10.0.1_vite@8.0.10_@types+node@22.19.19_esbuild@0.27.3_jiti@2.4.2_yaml@2.8.3_/node_modules/vite-imagetools/dist/types.d.ts:2
     1  src/index.js:16
[ELIFECYCLE] Command failed with exit code 2.

[lovell]

Hello, this will relate to 21263c3 and the provision of dual ESM/CJS, including dual type definitions. See #4537 for some more context.

The type definitions in sharp originated from DefinitelyTyped. Prior to 0.35.x, the "legacy" approach of exporting everything from a namespace via export = sharp was used. From 0.35.x, the CJS version continues to use this approach, but the ESM version has switched to exporting the namespace itself via export default sharp.

It looks like the tests have always assumed use of the namespace prefix:

sharp/test/types/sharp.test-d.ts

Line 111 in b520b33

.then<Buffer | undefined>((metadata: sharp.Metadata) => {

Two possible solutions (there may be others):

1. Mandate use of the sharp namespace as a prefix; retrospectively update the changelog with details of this breaking change. It's a quick fix but a poor user experience.

2. Refactor the type definitions to remove the namespace and export everything instead. We'll need to test this works in both an ESM and CJS context. A bit more work, but a better long term solution I think.

[lovell]

Commit e617d43 attempts to implement solution 2 by removing the use of namespace from the ESM type definitions. It also splits the type definition tests into CJS and ESM to help prevent further regression.

There's a release candidate available with this change.

npm i sharp@0.35.2-rc.0

@benmccann Please can you test this with SvelteKit if you're able.

[benmccann]

It seemed to mainly work. It got me from four errors down to one. The remaining issue is coming from a library we use that uses sharp, so maybe I'll need to upgrade that library as well. I'm afraid I don't think I'll have time to test this sort of transitive fix, but anyway, I think it's clearly an improvement in any case and hopefully the error will resolve itself once a final release is made and vite-imagetools is also updated to use it.

$ tsc
../../node_modules/.pnpm/vite-imagetools@10.0.1_vite@8.0.10_@types+node@22.19.19_esbuild@0.27.3_jiti@2.4.2_yaml@2.8.3_/node_modules/vite-imagetools/dist/types.d.ts:2:15 - error TS2614: Module '"sharp"' has no exported member 'Metadata'. Did you mean to use 'import Metadata from "sharp"' instead?

2 import type { Metadata } from 'sharp';
                ~~~~~~~~


Found 1 error in ../../node_modules/.pnpm/vite-imagetools@10.0.1_vite@8.0.10_@types+node@22.19.19_esbuild@0.27.3_jiti@2.4.2_yaml@2.8.3_/node_modules/vite-imagetools/dist/types.d.ts:2

[lovell]

Brilliant, thank you for testing Ben, I agree this remaining problem looks like mismatched versions.

[lovell]

v0.35.2 now available, thanks for reporting.