[KeyVault] - Update API Extractor version #17702
Conversation
maorleger
requested review from
bterlson,
chradek,
deyaaeldeen,
mikeharder,
praveenkuttappan,
sadasant,
witemple-msft and
xirzec
as code owners
ghost
added
the
| @@ -218,6 +221,7 @@ export interface JsonWebKey { | |||
| x?: Uint8Array; | |||
| y?: Uint8Array; | |||
| } | |||
| export { JsonWebKey_2 as JsonWebKey } | |||
There was a problem hiding this comment.
It's not a bug, but it is the reason #9410 is stalled... I believe this is the change that introduced this microsoft/rushstack#1767
My understanding is that names that will conflict / shadow declarations in dom.d.ts, etc will be renamed as such
There was a problem hiding this comment.
But it's super pervasive - any clash will cause this noise...
There was a problem hiding this comment.
https://github.com/microsoft/TypeScript/blob/cec2fda9a53620dc545a2c4d7b0156446ab145b4/lib/lib.webworker.d.ts looks like it's getting declared here, which makes me wonder if this is a common browser type, should we even be exporting this? Or simply declaring a shim?
There was a problem hiding this comment.
There was a problem hiding this comment.
It's unfortunately not that simple - this JsonWebKey type that we declare here is not conformant with IETF standard for JWK... I believe since the full set is all optional the difference for us is keyOps instead of key_ops... other languages have more differences but for us I think that's what we would need.
But we already GA'd with this shape...
There was a problem hiding this comment.
since this is just the interface name, can we maybe rename it so it doesn't conflict anymore, but still export the conflict as deprecated alias?
There was a problem hiding this comment.
I can, sure. But I do want to call out that if we want to upgrade api-extractor for everyone we will keep bumping into this. Some are already showing this issue (like Error_2, Location_2, etc) so I'm not sure what the answer would be globally. Any thoughts?
There was a problem hiding this comment.
Created #17710 to address this
| type KeyType_2 = string; | ||
| export { KeyType_2 as KeyType } |
There was a problem hiding this comment.
this has to be some kind of bug, right?
There was a problem hiding this comment.
There was a problem hiding this comment.
Speaking of differences - KeyType for us does not mean the same as keyType in node crypto - for us it's the kty (EC, RSA, etc). I think globally it's defined as "private" | "public" | "secret"
|
Closing as we did this as part of #17917 |
What
Why
As part of #9410 we are upgrading API Extractor piecemeal. We do need to have everyone upgraded to a later version
in order to support
import type/export typestatements which will eventually enable us to re-export OTel's APIs