chore: bump dev deps, typedoc, and typescript

panva · Sep 13, 2023 · 65d71f9 · 65d71f9
1 parent 0829829
commit 65d71f9
Show file tree

Hide file tree

Showing 93 changed files with 959 additions and 715 deletions.
diff --git a/docs/classes/jwe_compact_encrypt.CompactEncrypt.md b/docs/classes/jwe_compact_encrypt.CompactEncrypt.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 The CompactEncrypt class is used to build and encrypt Compact JWE strings.
 
-**`example`** Usage
+**`Example`**
 
 ```js
 const jwe = await new jose.CompactEncrypt(
@@ -74,9 +74,6 @@ ___
 Sets a content encryption key to use, by default a random suitable one is generated for the JWE
 enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended for test and vector
-  validation purposes.
-
 #### Parameters
 
 | Name | Type | Description |
@@ -87,6 +84,11 @@ enc" (Encryption Algorithm) Header Parameter.
 
 [`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
 
+**`Deprecated`**
+
+You should not use this method. It is only really intended for test and vector
+  validation purposes.
+
 ___
 
 ### setInitializationVector
@@ -96,9 +98,6 @@ ___
 Sets the JWE Initialization Vector to use for content encryption, by default a random suitable
 one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended for test and vector
-  validation purposes.
-
 #### Parameters
 
 | Name | Type | Description |
@@ -109,6 +108,11 @@ one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
 
 [`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
 
+**`Deprecated`**
+
+You should not use this method. It is only really intended for test and vector
+  validation purposes.
+
 ___
 
 ### setKeyManagementParameters

diff --git a/docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md b/docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 The FlattenedEncrypt class is used to build and encrypt Flattened JWE objects.
 
-**`example`** Usage
+**`Example`**
 
 ```js
 const jwe = await new jose.FlattenedEncrypt(
@@ -96,9 +96,6 @@ ___
 Sets a content encryption key to use, by default a random suitable one is generated for the JWE
 enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended for test and vector
-  validation purposes.
-
 #### Parameters
 
 | Name | Type | Description |
@@ -109,6 +106,11 @@ enc" (Encryption Algorithm) Header Parameter.
 
 [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
 
+**`Deprecated`**
+
+You should not use this method. It is only really intended for test and vector
+  validation purposes.
+
 ___
 
 ### setInitializationVector
@@ -118,9 +120,6 @@ ___
 Sets the JWE Initialization Vector to use for content encryption, by default a random suitable
 one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended for test and vector
-  validation purposes.
-
 #### Parameters
 
 | Name | Type | Description |
@@ -131,6 +130,11 @@ one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
 
 [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
 
+**`Deprecated`**
+
+You should not use this method. It is only really intended for test and vector
+  validation purposes.
+
 ___
 
 ### setKeyManagementParameters

diff --git a/docs/classes/jwe_general_encrypt.GeneralEncrypt.md b/docs/classes/jwe_general_encrypt.GeneralEncrypt.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 The GeneralEncrypt class is used to build and encrypt General JWE objects.
 
-**`example`** Usage
+**`Example`**
 
 ```js
 const jwe = await new jose.GeneralEncrypt(

diff --git a/docs/classes/jws_compact_sign.CompactSign.md b/docs/classes/jws_compact_sign.CompactSign.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 The CompactSign class is used to build and sign Compact JWS strings.
 
-**`example`** Usage
+**`Example`**
 
 ```js
 const jws = await new jose.CompactSign(

diff --git a/docs/classes/jws_flattened_sign.FlattenedSign.md b/docs/classes/jws_flattened_sign.FlattenedSign.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 The FlattenedSign class is used to build and sign Flattened JWS objects.
 
-**`example`** Usage
+**`Example`**
 
 ```js
 const jws = await new jose.FlattenedSign(

diff --git a/docs/classes/jws_general_sign.GeneralSign.md b/docs/classes/jws_general_sign.GeneralSign.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 The GeneralSign class is used to build and sign General JWS objects.
 
-**`example`** Usage
+**`Example`**
 
 ```js
 const jws = await new jose.GeneralSign(

diff --git a/docs/classes/jwt_encrypt.EncryptJWT.md b/docs/classes/jwt_encrypt.EncryptJWT.md
@@ -8,7 +8,7 @@ Support from the community to continue maintaining and improving this module is
 
 The EncryptJWT class is used to build and encrypt Compact JWE formatted JSON Web Tokens.
 
-**`example`** Usage
+**`Example`**
 
 ```js
 const secret = jose.base64url.decode('zH4NRP1HMALxxCFnRZABFA7GOJtzU_gIj02alfL1lvI')
@@ -86,12 +86,14 @@ ___
 
 Replicates the "aud" (Audience) Claim as a JWE Protected Header Parameter.
 
-**`see`** [RFC7519#section-5.3](https://www.rfc-editor.org/rfc/rfc7519#section-5.3)
-
 #### Returns
 
 [`EncryptJWT`](jwt_encrypt.EncryptJWT.md)
 
+**`See`**
+
+[RFC7519#section-5.3](https://www.rfc-editor.org/rfc/rfc7519#section-5.3)
+
 ___
 
 ### replicateIssuerAsHeader
@@ -100,12 +102,14 @@ ___
 
 Replicates the "iss" (Issuer) Claim as a JWE Protected Header Parameter.
 
-**`see`** [RFC7519#section-5.3](https://www.rfc-editor.org/rfc/rfc7519#section-5.3)
-
 #### Returns
 
 [`EncryptJWT`](jwt_encrypt.EncryptJWT.md)
 
+**`See`**
+
+[RFC7519#section-5.3](https://www.rfc-editor.org/rfc/rfc7519#section-5.3)
+
 ___
 
 ### replicateSubjectAsHeader
@@ -114,12 +118,14 @@ ___
 
 Replicates the "sub" (Subject) Claim as a JWE Protected Header Parameter.
 
-**`see`** [RFC7519#section-5.3](https://www.rfc-editor.org/rfc/rfc7519#section-5.3)
-
 #### Returns
 
 [`EncryptJWT`](jwt_encrypt.EncryptJWT.md)
 
+**`See`**
+
+[RFC7519#section-5.3](https://www.rfc-editor.org/rfc/rfc7519#section-5.3)
+
 ___
 
 ### setAudience
@@ -147,9 +153,6 @@ ___
 Sets a content encryption key to use, by default a random suitable one is generated for the JWE
 enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended for test and vector
-  validation purposes.
-
 #### Parameters
 
 | Name | Type | Description |
@@ -160,6 +163,11 @@ enc" (Encryption Algorithm) Header Parameter.
 
 [`EncryptJWT`](jwt_encrypt.EncryptJWT.md)
 
+**`Deprecated`**
+
+You should not use this method. It is only really intended for test and vector
+  validation purposes.
+
 ___
 
 ### setExpirationTime
@@ -187,9 +195,6 @@ ___
 Sets the JWE Initialization Vector to use for content encryption, by default a random suitable
 one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended for test and vector
-  validation purposes.
-
 #### Parameters
 
 | Name | Type | Description |
@@ -200,6 +205,11 @@ one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
 
 [`EncryptJWT`](jwt_encrypt.EncryptJWT.md)
 
+**`Deprecated`**
+
+You should not use this method. It is only really intended for test and vector
+  validation purposes.
+
 ___
 
 ### setIssuedAt

diff --git a/docs/classes/jwt_sign.SignJWT.md b/docs/classes/jwt_sign.SignJWT.md
@@ -8,7 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 The SignJWT class is used to build and sign Compact JWS formatted JSON Web Tokens.
 
-**`example`** Usage with a symmetric secret
+**`Example`**
+
+Usage with a symmetric secret
 
 ```js
 const secret = new TextEncoder().encode(
@@ -27,7 +29,9 @@ const jwt = await new jose.SignJWT({ 'urn:example:claim': true })
 console.log(jwt)
 ```
 
-**`example`** Usage with a private PKCS#8 encoded RSA key
+**`Example`**
+
+Usage with a private PKCS#8 encoded RSA key
 
 ```js
 const alg = 'RS256'
@@ -72,7 +76,9 @@ const jwt = await new jose.SignJWT({ 'urn:example:claim': true })
 console.log(jwt)
 ```
 
-**`example`** Usage with a private JWK encoded RSA key
+**`Example`**
+
+Usage with a private JWK encoded RSA key
 
 ```js
 const alg = 'RS256'

diff --git a/docs/classes/jwt_unsecured.UnsecuredJWT.md b/docs/classes/jwt_unsecured.UnsecuredJWT.md
@@ -8,7 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 The UnsecuredJWT class is a utility for dealing with `{ "alg": "none" }` Unsecured JWTs.
 
-**`example`** Encoding
+**`Example`**
+
+Encoding
 
 ```js
 const unsecuredJwt = new jose.UnsecuredJWT({ 'urn:example:claim': true })
@@ -21,7 +23,9 @@ const unsecuredJwt = new jose.UnsecuredJWT({ 'urn:example:claim': true })
 console.log(unsecuredJwt)
 ```
 
-**`example`** Decoding
+**`Example`**
+
+Decoding
 
 ```js
 const payload = jose.UnsecuredJWT.decode(jwt, {

diff --git a/docs/classes/util_errors.JOSEAlgNotAllowed.md b/docs/classes/util_errors.JOSEAlgNotAllowed.md
@@ -8,15 +8,19 @@ Support from the community to continue maintaining and improving this module is
 
 An error subclass thrown when a JOSE Algorithm is not allowed per developer preference.
 
-**`example`** Checking thrown error is this one using a stable error code
+**`Example`**
+
+Checking thrown error is this one using a stable error code
 
 ```js
 if (err.code === 'ERR_JOSE_ALG_NOT_ALLOWED') {
   // ...
 }
 ```
 
-**`example`** Checking thrown error is this one using `instanceof`
+**`Example`**
+
+Checking thrown error is this one using `instanceof`
 
 ```js
 if (err instanceof jose.errors.JOSEAlgNotAllowed) {

diff --git a/docs/classes/util_errors.JOSEError.md b/docs/classes/util_errors.JOSEError.md
@@ -8,7 +8,9 @@ Support from the community to continue maintaining and improving this module is
 
 A generic Error that all other JOSE specific Error subclasses extend.
 
-**`example`** Checking thrown error is a JOSE one
+**`Example`**
+
+Checking thrown error is a JOSE one
 
 ```js
 if (err instanceof jose.errors.JOSEError) {

diff --git a/docs/classes/util_errors.JOSENotSupported.md b/docs/classes/util_errors.JOSENotSupported.md
@@ -9,15 +9,19 @@ Support from the community to continue maintaining and improving this module is
 An error subclass thrown when a particular feature or algorithm is not supported by this
 implementation or JOSE in general.
 
-**`example`** Checking thrown error is this one using a stable error code
+**`Example`**
+
+Checking thrown error is this one using a stable error code
 
 ```js
 if (err.code === 'ERR_JOSE_NOT_SUPPORTED') {
   // ...
 }
 ```
 
-**`example`** Checking thrown error is this one using `instanceof`
+**`Example`**
+
+Checking thrown error is this one using `instanceof`
 
 ```js
 if (err instanceof jose.errors.JOSENotSupported) {

diff --git a/docs/classes/util_errors.JWEDecryptionFailed.md b/docs/classes/util_errors.JWEDecryptionFailed.md
@@ -8,15 +8,19 @@ Support from the community to continue maintaining and improving this module is
 
 An error subclass thrown when a JWE ciphertext decryption fails.
 
-**`example`** Checking thrown error is this one using a stable error code
+**`Example`**
+
+Checking thrown error is this one using a stable error code
 
 ```js
 if (err.code === 'ERR_JWE_DECRYPTION_FAILED') {
   // ...
 }
 ```
 
-**`example`** Checking thrown error is this one using `instanceof`
+**`Example`**
+
+Checking thrown error is this one using `instanceof`
 
 ```js
 if (err instanceof jose.errors.JWEDecryptionFailed) {

diff --git a/docs/classes/util_errors.JWEInvalid.md b/docs/classes/util_errors.JWEInvalid.md
@@ -8,15 +8,19 @@ Support from the community to continue maintaining and improving this module is
 
 An error subclass thrown when a JWE is invalid.
 
-**`example`** Checking thrown error is this one using a stable error code
+**`Example`**
+
+Checking thrown error is this one using a stable error code
 
 ```js
 if (err.code === 'ERR_JWE_INVALID') {
   // ...
 }
 ```
 
-**`example`** Checking thrown error is this one using `instanceof`
+**`Example`**
+
+Checking thrown error is this one using `instanceof`
 
 ```js
 if (err instanceof jose.errors.JWEInvalid) {