refactor(types): make JWKParameters.kty compatible with @types/node a…

…nd @types/web It is still a required property but this way the interface is compatible with @types/node crypto.JsonWebKey type and @types/web WebCryptoAPI's JsonWebKey dictionary
panva · Feb 23, 2025 · bb6ccfe · bb6ccfe
1 parent 0c74cb6
commit bb6ccfe
Show file tree

Hide file tree

Showing 16 changed files with 79 additions and 79 deletions.
diff --git a/docs/types/interfaces/CompactJWEHeaderParameters.md b/docs/types/interfaces/CompactJWEHeaderParameters.md
@@ -62,7 +62,7 @@ JWE "crit" (Critical) Header Parameter
 
 ### jwk?
 
-• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"kty"` \| `"crv"` \| `"e"` \| `"n"`\>
+• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"crv"` \| `"e"` \| `"n"` \| `"kty"`\>
 
 "jwk" (JSON Web Key) Header Parameter
 

diff --git a/docs/types/interfaces/CompactJWSHeaderParameters.md b/docs/types/interfaces/CompactJWSHeaderParameters.md
@@ -59,7 +59,7 @@ JWS "crit" (Critical) Header Parameter
 
 ### jwk?
 
-• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"kty"` \| `"crv"` \| `"e"` \| `"n"`\>
+• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"crv"` \| `"e"` \| `"n"` \| `"kty"`\>
 
 "jwk" (JSON Web Key) Header Parameter
 

diff --git a/docs/types/interfaces/JWEHeaderParameters.md b/docs/types/interfaces/JWEHeaderParameters.md
@@ -62,7 +62,7 @@ JWE "enc" (Encryption Algorithm) Header Parameter
 
 ### jwk?
 
-• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"kty"` \| `"crv"` \| `"e"` \| `"n"`\>
+• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"crv"` \| `"e"` \| `"n"` \| `"kty"`\>
 
 "jwk" (JSON Web Key) Header Parameter
 

diff --git a/docs/types/interfaces/JWK.md b/docs/types/interfaces/JWK.md
@@ -19,14 +19,6 @@ key types are supported.
 
 ## Properties
 
-### kty
-
-• **kty**: `string`
-
-JWK "kty" (Key Type) Parameter
-
-***
-
 ### alg?
 
 • `optional` **alg**: `string`
@@ -114,6 +106,14 @@ JWK "kid" (Key ID) Parameter
 
 ***
 
+### kty?
+
+• `optional` **kty**: `string`
+
+JWK "kty" (Key Type) Parameter
+
+***
+
 ### n?
 
 • `optional` **n**: `string`

diff --git a/docs/types/interfaces/JWKParameters.md b/docs/types/interfaces/JWKParameters.md
@@ -8,14 +8,6 @@ Generic JSON Web Key Parameters.
 
 ## Properties
 
-### kty
-
-• **kty**: `string`
-
-JWK "kty" (Key Type) Parameter
-
-***
-
 ### alg?
 
 • `optional` **alg**: `string`
@@ -52,6 +44,14 @@ JWK "kid" (Key ID) Parameter
 
 ***
 
+### kty?
+
+• `optional` **kty**: `string`
+
+JWK "kty" (Key Type) Parameter
+
+***
+
 ### use?
 
 • `optional` **use**: `string`

diff --git a/docs/types/interfaces/JWK_EC_Private.md b/docs/types/interfaces/JWK_EC_Private.md
@@ -24,14 +24,6 @@ EC JWK "d" (ECC Private Key) Parameter
 
 ***
 
-### kty
-
-• **kty**: `string`
-
-JWK "kty" (Key Type) Parameter
-
-***
-
 ### x
 
 • **x**: `string`
@@ -84,6 +76,14 @@ JWK "kid" (Key ID) Parameter
 
 ***
 
+### kty?
+
+• `optional` **kty**: `string`
+
+JWK "kty" (Key Type) Parameter
+
+***
+
 ### use?
 
 • `optional` **use**: `string`

diff --git a/docs/types/interfaces/JWK_EC_Public.md b/docs/types/interfaces/JWK_EC_Public.md
@@ -16,14 +16,6 @@ EC JWK "crv" (Curve) Parameter
 
 ***
 
-### kty
-
-• **kty**: `string`
-
-JWK "kty" (Key Type) Parameter
-
-***
-
 ### x
 
 • **x**: `string`
@@ -76,6 +68,14 @@ JWK "kid" (Key ID) Parameter
 
 ***
 
+### kty?
+
+• `optional` **kty**: `string`
+
+JWK "kty" (Key Type) Parameter
+
+***
+
 ### use?
 
 • `optional` **use**: `string`

diff --git a/docs/types/interfaces/JWK_OKP_Private.md b/docs/types/interfaces/JWK_OKP_Private.md
@@ -24,14 +24,6 @@ OKP JWK "d" (The Private Key) Parameter
 
 ***
 
-### kty
-
-• **kty**: `string`
-
-JWK "kty" (Key Type) Parameter
-
-***
-
 ### x
 
 • **x**: `string`
@@ -76,6 +68,14 @@ JWK "kid" (Key ID) Parameter
 
 ***
 
+### kty?
+
+• `optional` **kty**: `string`
+
+JWK "kty" (Key Type) Parameter
+
+***
+
 ### use?
 
 • `optional` **use**: `string`

diff --git a/docs/types/interfaces/JWK_OKP_Public.md b/docs/types/interfaces/JWK_OKP_Public.md
@@ -16,14 +16,6 @@ OKP JWK "crv" (The Subtype of Key Pair) Parameter
 
 ***
 
-### kty
-
-• **kty**: `string`
-
-JWK "kty" (Key Type) Parameter
-
-***
-
 ### x
 
 • **x**: `string`
@@ -68,6 +60,14 @@ JWK "kid" (Key ID) Parameter
 
 ***
 
+### kty?
+
+• `optional` **kty**: `string`
+
+JWK "kty" (Key Type) Parameter
+
+***
+
 ### use?
 
 • `optional` **use**: `string`

diff --git a/docs/types/interfaces/JWK_RSA_Private.md b/docs/types/interfaces/JWK_RSA_Private.md
@@ -40,14 +40,6 @@ RSA JWK "e" (Exponent) Parameter
 
 ***
 
-### kty
-
-• **kty**: `string`
-
-JWK "kty" (Key Type) Parameter
-
-***
-
 ### n
 
 • **n**: `string`
@@ -116,6 +108,14 @@ JWK "kid" (Key ID) Parameter
 
 ***
 
+### kty?
+
+• `optional` **kty**: `string`
+
+JWK "kty" (Key Type) Parameter
+
+***
+
 ### use?
 
 • `optional` **use**: `string`

diff --git a/docs/types/interfaces/JWK_RSA_Public.md b/docs/types/interfaces/JWK_RSA_Public.md
@@ -16,14 +16,6 @@ RSA JWK "e" (Exponent) Parameter
 
 ***
 
-### kty
-
-• **kty**: `string`
-
-JWK "kty" (Key Type) Parameter
-
-***
-
 ### n
 
 • **n**: `string`
@@ -68,6 +60,14 @@ JWK "kid" (Key ID) Parameter
 
 ***
 
+### kty?
+
+• `optional` **kty**: `string`
+
+JWK "kty" (Key Type) Parameter
+
+***
+
 ### use?
 
 • `optional` **use**: `string`

diff --git a/docs/types/interfaces/JWK_oct.md b/docs/types/interfaces/JWK_oct.md
@@ -16,14 +16,6 @@ Oct JWK "k" (Key Value) Parameter
 
 ***
 
-### kty
-
-• **kty**: `string`
-
-JWK "kty" (Key Type) Parameter
-
-***
-
 ### alg?
 
 • `optional` **alg**: `string`
@@ -60,6 +52,14 @@ JWK "kid" (Key ID) Parameter
 
 ***
 
+### kty?
+
+• `optional` **kty**: `string`
+
+JWK "kty" (Key Type) Parameter
+
+***
+
 ### use?
 
 • `optional` **use**: `string`

diff --git a/docs/types/interfaces/JWSHeaderParameters.md b/docs/types/interfaces/JWSHeaderParameters.md
@@ -59,7 +59,7 @@ JWS "crit" (Critical) Header Parameter
 
 ### jwk?
 
-• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"kty"` \| `"crv"` \| `"e"` \| `"n"`\>
+• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"crv"` \| `"e"` \| `"n"` \| `"kty"`\>
 
 "jwk" (JSON Web Key) Header Parameter
 

diff --git a/docs/types/interfaces/JWTHeaderParameters.md b/docs/types/interfaces/JWTHeaderParameters.md
@@ -59,7 +59,7 @@ JWS "crit" (Critical) Header Parameter
 
 ### jwk?
 
-• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"kty"` \| `"crv"` \| `"e"` \| `"n"`\>
+• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"crv"` \| `"e"` \| `"n"` \| `"kty"`\>
 
 "jwk" (JSON Web Key) Header Parameter
 

diff --git a/docs/types/interfaces/JoseHeaderParameters.md b/docs/types/interfaces/JoseHeaderParameters.md
@@ -24,7 +24,7 @@ Support from the community to continue maintaining and improving this module is
 
 ### jwk?
 
-• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"kty"` \| `"crv"` \| `"e"` \| `"n"`\>
+• `optional` **jwk**: [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`JWK`](JWK.md), `"x"` \| `"y"` \| `"crv"` \| `"e"` \| `"n"` \| `"kty"`\>
 
 "jwk" (JSON Web Key) Header Parameter
 

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -1,7 +1,7 @@
 /** Generic JSON Web Key Parameters. */
 export interface JWKParameters {
   /** JWK "kty" (Key Type) Parameter */
-  kty: string
+  kty?: string
   /**
    * JWK "alg" (Algorithm) Parameter
    *