From bb6ccfed3efd5c84c540c2a1f621b9d2951f2b84 Mon Sep 17 00:00:00 2001 From: Filip Skokan Date: Sun, 23 Feb 2025 12:16:59 +0100 Subject: [PATCH] refactor(types): make JWKParameters.kty compatible with @types/node and @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 --- .../interfaces/CompactJWEHeaderParameters.md | 2 +- .../interfaces/CompactJWSHeaderParameters.md | 2 +- docs/types/interfaces/JWEHeaderParameters.md | 2 +- docs/types/interfaces/JWK.md | 16 ++++++++-------- docs/types/interfaces/JWKParameters.md | 16 ++++++++-------- docs/types/interfaces/JWK_EC_Private.md | 16 ++++++++-------- docs/types/interfaces/JWK_EC_Public.md | 16 ++++++++-------- docs/types/interfaces/JWK_OKP_Private.md | 16 ++++++++-------- docs/types/interfaces/JWK_OKP_Public.md | 16 ++++++++-------- docs/types/interfaces/JWK_RSA_Private.md | 16 ++++++++-------- docs/types/interfaces/JWK_RSA_Public.md | 16 ++++++++-------- docs/types/interfaces/JWK_oct.md | 16 ++++++++-------- docs/types/interfaces/JWSHeaderParameters.md | 2 +- docs/types/interfaces/JWTHeaderParameters.md | 2 +- docs/types/interfaces/JoseHeaderParameters.md | 2 +- src/types.d.ts | 2 +- 16 files changed, 79 insertions(+), 79 deletions(-) diff --git a/docs/types/interfaces/CompactJWEHeaderParameters.md b/docs/types/interfaces/CompactJWEHeaderParameters.md index f95ae97b09..987b4ab16d 100644 --- 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 index 19d4ff4484..b7c26edec3 100644 --- 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 index bd6fc78c7a..5c10f180bf 100644 --- 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 index c1642e1004..078e59a51a 100644 --- 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 index 002a5b4fb9..f85f84353d 100644 --- 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 index 691d8ae3d8..aef630084c 100644 --- 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 index 068737d3ec..d60fc8bce8 100644 --- 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 index ac5962c557..c7ae1c7524 100644 --- 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 index b86a37fd23..ae65fca185 100644 --- 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 index 11730cc2e1..30fe0d6d20 100644 --- 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 index 2f68381b7e..6b6a487f75 100644 --- 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 index 59fb611afc..0e42009645 100644 --- 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 index 02dce1352e..0517841973 100644 --- 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 index 6a31c30260..a754528851 100644 --- 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 index 6fbf0a640f..f94598f0fd 100644 --- 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 index c3d0e39610..4a908d4693 100644 --- 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 *