chore: upgrade dev dependencies, typescript, and docs

panva · Dec 3, 2024 · 08be034 · 08be034
1 parent 0d9f5f1
commit 08be034
Show file tree

Hide file tree

Showing 21 changed files with 333 additions and 660 deletions.
diff --git a/docs/jwe/compact/decrypt/functions/compactDecrypt.md b/docs/jwe/compact/decrypt/functions/compactDecrypt.md
@@ -4,7 +4,7 @@
 
 Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
 
-## compactDecrypt(jwe, key, options)
+## Call Signature
 
 ▸ **compactDecrypt**(`jwe`, `key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`CompactDecryptResult`](../../../../types/interfaces/CompactDecryptResult.md)\>
 
@@ -37,7 +37,7 @@ console.log(protectedHeader)
 console.log(new TextDecoder().decode(plaintext))
 ```
 
-## compactDecrypt(jwe, getKey, options)
+## Call Signature
 
 ▸ **compactDecrypt**\<`KeyLikeType`\>(`jwe`, `getKey`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`CompactDecryptResult`](../../../../types/interfaces/CompactDecryptResult.md) & [`ResolvedKey`](../../../../types/interfaces/ResolvedKey.md)\<`KeyLikeType`\>\>
 

diff --git a/docs/jwe/flattened/decrypt/functions/flattenedDecrypt.md b/docs/jwe/flattened/decrypt/functions/flattenedDecrypt.md
@@ -4,7 +4,7 @@
 
 Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
 
-## flattenedDecrypt(jwe, key, options)
+## Call Signature
 
 ▸ **flattenedDecrypt**(`jwe`, `key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`FlattenedDecryptResult`](../../../../types/interfaces/FlattenedDecryptResult.md)\>
 
@@ -47,7 +47,7 @@ console.log(decoder.decode(plaintext))
 console.log(decoder.decode(additionalAuthenticatedData))
 ```
 
-## flattenedDecrypt(jwe, getKey, options)
+## Call Signature
 
 ▸ **flattenedDecrypt**\<`KeyLikeType`\>(`jwe`, `getKey`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`FlattenedDecryptResult`](../../../../types/interfaces/FlattenedDecryptResult.md) & [`ResolvedKey`](../../../../types/interfaces/ResolvedKey.md)\<`KeyLikeType`\>\>
 

diff --git a/docs/jwe/general/decrypt/functions/generalDecrypt.md b/docs/jwe/general/decrypt/functions/generalDecrypt.md
@@ -4,7 +4,7 @@
 
 Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
 
-## generalDecrypt(jwe, key, options)
+## Call Signature
 
 ▸ **generalDecrypt**(`jwe`, `key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GeneralDecryptResult`](../../../../types/interfaces/GeneralDecryptResult.md)\>
 
@@ -51,7 +51,7 @@ console.log(decoder.decode(plaintext))
 console.log(decoder.decode(additionalAuthenticatedData))
 ```
 
-## generalDecrypt(jwe, getKey, options)
+## Call Signature
 
 ▸ **generalDecrypt**\<`KeyLikeType`\>(`jwe`, `getKey`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GeneralDecryptResult`](../../../../types/interfaces/GeneralDecryptResult.md) & [`ResolvedKey`](../../../../types/interfaces/ResolvedKey.md)\<`KeyLikeType`\>\>
 

diff --git a/docs/jwks/remote/README.md b/docs/jwks/remote/README.md
@@ -2,6 +2,10 @@
 
 ## Index
 
+### Functions
+
+- [createRemoteJWKSet](functions/createRemoteJWKSet.md)
+
 ### Interfaces
 
 - [ExportedJWKSCache](interfaces/ExportedJWKSCache.md)
@@ -14,7 +18,3 @@
 ### Variables
 
 - [jwksCache](variables/jwksCache.md)
-
-### Functions
-
-- [createRemoteJWKSet](functions/createRemoteJWKSet.md)
diff --git a/docs/jws/compact/verify/functions/compactVerify.md b/docs/jws/compact/verify/functions/compactVerify.md
@@ -4,7 +4,7 @@
 
 Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
 
-## compactVerify(jws, key, options)
+## Call Signature
 
 ▸ **compactVerify**(`jws`, `key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`CompactVerifyResult`](../../../../types/interfaces/CompactVerifyResult.md)\>
 
@@ -37,7 +37,7 @@ console.log(protectedHeader)
 console.log(new TextDecoder().decode(payload))
 ```
 
-## compactVerify(jws, getKey, options)
+## Call Signature
 
 ▸ **compactVerify**\<`KeyLikeType`\>(`jws`, `getKey`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`CompactVerifyResult`](../../../../types/interfaces/CompactVerifyResult.md) & [`ResolvedKey`](../../../../types/interfaces/ResolvedKey.md)\<`KeyLikeType`\>\>
 

diff --git a/docs/jws/flattened/verify/functions/flattenedVerify.md b/docs/jws/flattened/verify/functions/flattenedVerify.md
@@ -4,7 +4,7 @@
 
 Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
 
-## flattenedVerify(jws, key, options)
+## Call Signature
 
 ▸ **flattenedVerify**(`jws`, `key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`FlattenedVerifyResult`](../../../../types/interfaces/FlattenedVerifyResult.md)\>
 
@@ -42,7 +42,7 @@ console.log(protectedHeader)
 console.log(decoder.decode(payload))
 ```
 
-## flattenedVerify(jws, getKey, options)
+## Call Signature
 
 ▸ **flattenedVerify**\<`KeyLikeType`\>(`jws`, `getKey`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`FlattenedVerifyResult`](../../../../types/interfaces/FlattenedVerifyResult.md) & [`ResolvedKey`](../../../../types/interfaces/ResolvedKey.md)\<`KeyLikeType`\>\>
 

diff --git a/docs/jws/general/verify/functions/generalVerify.md b/docs/jws/general/verify/functions/generalVerify.md
@@ -4,7 +4,7 @@
 
 Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
 
-## generalVerify(jws, key, options)
+## Call Signature
 
 ▸ **generalVerify**(`jws`, `key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GeneralVerifyResult`](../../../../types/interfaces/GeneralVerifyResult.md)\>
 
@@ -45,7 +45,7 @@ console.log(protectedHeader)
 console.log(new TextDecoder().decode(payload))
 ```
 
-## generalVerify(jws, getKey, options)
+## Call Signature
 
 ▸ **generalVerify**\<`KeyLikeType`\>(`jws`, `getKey`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GeneralVerifyResult`](../../../../types/interfaces/GeneralVerifyResult.md) & [`ResolvedKey`](../../../../types/interfaces/ResolvedKey.md)\<`KeyLikeType`\>\>
 

diff --git a/docs/jwt/decrypt/functions/jwtDecrypt.md b/docs/jwt/decrypt/functions/jwtDecrypt.md
@@ -4,7 +4,7 @@
 
 Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
 
-## jwtDecrypt(jwt, key, options)
+## Call Signature
 
 ▸ **jwtDecrypt**\<`PayloadType`\>(`jwt`, `key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`JWTDecryptResult`](../../../types/interfaces/JWTDecryptResult.md)\<`PayloadType`\>\>
 
@@ -48,7 +48,7 @@ console.log(protectedHeader)
 console.log(payload)
 ```
 
-## jwtDecrypt(jwt, getKey, options)
+## Call Signature
 
 ▸ **jwtDecrypt**\<`PayloadType`, `KeyLikeType`\>(`jwt`, `getKey`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`JWTDecryptResult`](../../../types/interfaces/JWTDecryptResult.md)\<`PayloadType`\> & [`ResolvedKey`](../../../types/interfaces/ResolvedKey.md)\<`KeyLikeType`\>\>
 

diff --git a/docs/jwt/verify/functions/jwtVerify.md b/docs/jwt/verify/functions/jwtVerify.md
@@ -4,7 +4,7 @@
 
 Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
 
-## jwtVerify(jwt, key, options)
+## Call Signature
 
 ▸ **jwtVerify**\<`PayloadType`\>(`jwt`, `key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`JWTVerifyResult`](../../../types/interfaces/JWTVerifyResult.md)\<`PayloadType`\>\>
 
@@ -100,7 +100,7 @@ console.log(protectedHeader)
 console.log(payload)
 ```
 
-## jwtVerify(jwt, getKey, options)
+## Call Signature
 
 ▸ **jwtVerify**\<`PayloadType`, `KeyLikeType`\>(`jwt`, `getKey`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`JWTVerifyResult`](../../../types/interfaces/JWTVerifyResult.md)\<`PayloadType`\> & [`ResolvedKey`](../../../types/interfaces/ResolvedKey.md)\<`KeyLikeType`\>\>
 

diff --git a/docs/types/interfaces/CompactJWEHeaderParameters.md b/docs/types/interfaces/CompactJWEHeaderParameters.md
@@ -6,6 +6,10 @@ Support from the community to continue maintaining and improving this module is
 
 Recognized Compact JWE Header Parameters, any other Header Members may also be present.
 
+## Indexable
+
+ \[`propName`: `string`\]: `unknown`
+
 ## Properties
 
 ### alg

diff --git a/docs/types/interfaces/CompactJWSHeaderParameters.md b/docs/types/interfaces/CompactJWSHeaderParameters.md
@@ -6,6 +6,10 @@ Support from the community to continue maintaining and improving this module is
 
 Recognized Compact JWS Header Parameters, any other Header Members may also be present.
 
+## Indexable
+
+ \[`propName`: `string`\]: `unknown`
+
 ## Properties
 
 ### alg

diff --git a/docs/types/interfaces/JWK.md b/docs/types/interfaces/JWK.md
@@ -122,16 +122,6 @@ RSA JWK "n" (Modulus) Parameter
 
 ***
 
-### oth?
-
-• `optional` **oth**: `object`[]
-
-Private RSA JWK "oth" (Other Primes Info) Parameter
-
-This parameter is not supported
-
-***
-
 ### p?
 
 • `optional` **p**: `string`

diff --git a/docs/types/interfaces/JWK_RSA_Private.md b/docs/types/interfaces/JWK_RSA_Private.md
@@ -116,16 +116,6 @@ JWK "kid" (Key ID) Parameter
 
 ***
 
-### oth?
-
-• `optional` **oth**: `object`[]
-
-RSA JWK "oth" (Other Primes Info) Parameter
-
-This parameter is not supported
-
-***
-
 ### use?
 
 • `optional` **use**: `string`

diff --git a/docs/types/interfaces/JWTHeaderParameters.md b/docs/types/interfaces/JWTHeaderParameters.md
@@ -6,6 +6,10 @@ Support from the community to continue maintaining and improving this module is
 
 Recognized Signed JWT Header Parameters, any other Header Members may also be present.
 
+## Indexable
+
+ \[`propName`: `string`\]: `unknown`
+
 ## Properties
 
 ### alg