[Web API type definition issue] crypto.subtle.importKey does not support jwk as a key format

[Ethan-Dankiw]

Summary

crypto.subtle.importKey does not support jwk as a key format

Expected vs. Actual Behavior

This is the current specification for the usage of the browser crypto import key format.
https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey
https://w3c.github.io/webcrypto/#SubtleCrypto-method-importKey

According to the rule TS2769, crypto.subtle.importKey does not support the key format of "jwk" despite it being explicitly allowed as a format in the MDN provided in the above link.

I would expect this to be an error as the behavior I experienced differs from what is described in the developer docs.

Usage of the code causing the error

Described error in my IDE at the format line variable inside the importKey function call

Playground Link

Not 100% sure how useful this will be

Typescript Lang Playground

Browser Support

• This API is supported in at least two major browser engines (not two Chromium-based browsers).

Have Tried The Latest Releases

• This issue applies to the latest release of TypeScript.
• This issue applies to the latest release of @types/web.

Additional Context

Currently using typescript version 5.9.3

Terminal Output

❯ tsc --version
Version 5.9.3

Currently using @types/web version 0.0.294

❯ pnpm list @types/web
Legend: production dependency, optional only, dev only

<omitted>

devDependencies:
@types/web 0.0.294

[Renegade334]

It does, but the jwk signature does not accept BufferSource inputs, hence why you are not getting a matching overload.

The error message is somewhat an artifact of the compiler – your provided parameters don't match any overload, but it'll only tell you why they don't match the last overload in the list, which in this case is the non-jwk one.

[Ethan-Dankiw]

Thank you so much, would you happen to know the reason behind allowing BufferSource for key formats except for the jwk? I wouldn't mind having additional knowledge if you have some sources available :)

[Renegade334]

SubtleCrypto.importKey will throw an error if the input format is "jwk" and keyData is a buffer (14.3.9.2 in the crypto spec). The source has to be a jwk object in this case.

[Ethan-Dankiw]

That is actually pretty helpful to know, so any data passed as the key data that is not a JsonWebKey dictionary an error seems to be thrown.

You're a legend!