jose 4.8.3 → 4.9.0

package/dist/types/jwk/thumbprint.d.ts

@@ -3,19 +3,42 @@ import type { JWK } from '../types';
  * Calculates a base64url-encoded JSON Web Key (JWK) Thumbprint as per
  * [RFC7638](https://www.rfc-editor.org/rfc/rfc7638).
  *
- * @param jwk JSON Web Key.
- * @param digestAlgorithm Digest Algorithm to use for calculating the thumbprint.
- * Default is sha256. Accepted is "sha256", "sha384", "sha512".
- *
  * @example Usage
+ *
  * ```js
  * const thumbprint = await jose.calculateJwkThumbprint({
- *   kty: 'RSA',
- *   e: 'AQAB',
- *   n: '12oBZRhCiZFJLcPg59LkZZ9mdhSMTKAQZYq32k_ti5SBB6jerkh-WzOMAO664r_qyLkqHUSp3u5SbXtseZEpN3XPWGKSxjsy-1JyEFTdLSYe6f9gfrmxkUF_7DTpq0gn6rntP05g2-wFW50YO7mosfdslfrTJYWHFhJALabAeYirYD7-9kqq9ebfFMF4sRRELbv9oi36As6Q9B3Qb5_C1rAzqfao_PCsf9EPsTZsVVVkA5qoIAr47lo1ipfiBPxUCCNSdvkmDTYgvvRm6ZoMjFbvOtgyts55fXKdMWv7I9HMD5HwE9uW839PWA514qhbcIsXEYSFMPMV6fnlsiZvQQ'
+ *   kty: 'EC',
+ *   crv: 'P-256',
+ *   x: 'jJ6Flys3zK9jUhnOHf6G49Dyp5hah6CNP84-gY-n9eo',
+ *   y: 'nhI6iD5eFXgBTLt_1p3aip-5VbZeMhxeFSpjfEAf7Ww',
  * })
  *
  * console.log(thumbprint)
+ * // 'w9eYdC6_s_tLQ8lH6PUpc0mddazaqtPgeC2IgWDiqY8'
  * ```
+ *
+ * @param jwk JSON Web Key.
+ * @param digestAlgorithm Digest Algorithm to use for calculating the thumbprint. Default is "sha256".
  */
 export declare function calculateJwkThumbprint(jwk: JWK, digestAlgorithm?: 'sha256' | 'sha384' | 'sha512'): Promise<string>;
+/**
+ * Calculates a JSON Web Key (JWK) Thumbprint URI as per [RFC9278](https://www.rfc-editor.org/rfc/rfc9278).
+ *
+ * @example Usage
+ *
+ * ```js
+ * const thumbprintUri = await jose.calculateJwkThumbprintUri({
+ *   kty: 'EC',
+ *   crv: 'P-256',
+ *   x: 'jJ6Flys3zK9jUhnOHf6G49Dyp5hah6CNP84-gY-n9eo',
+ *   y: 'nhI6iD5eFXgBTLt_1p3aip-5VbZeMhxeFSpjfEAf7Ww',
+ * })
+ *
+ * console.log(thumbprint)
+ * // 'urn:ietf:params:oauth:jwk-thumbprint:sha-256:w9eYdC6_s_tLQ8lH6PUpc0mddazaqtPgeC2IgWDiqY8'
+ * ```
+ *
+ * @param jwk JSON Web Key.
+ * @param digestAlgorithm Digest Algorithm to use for calculating the thumbprint. Default is "sha256".
+ */
+export declare function calculateJwkThumbprintUri(jwk: JWK, digestAlgorithm?: 'sha256' | 'sha384' | 'sha512'): Promise<string>;

package/dist/types/jwks/local.d.ts

@@ -1,11 +1,7 @@
 import type { KeyLike, JWSHeaderParameters, JSONWebKeySet, FlattenedJWSInput, GetKeyFunction } from '../types';
-/**
- * @private
- */
+/** @private */
 export declare function isJWKSLike(jwks: unknown): jwks is JSONWebKeySet;
-/**
- * @private
- */
+/** @private */
 export declare class LocalJWKSet {
     protected _jwks?: JSONWebKeySet;
     private _cached;
@@ -13,14 +9,13 @@ export declare class LocalJWKSet {
     getKey(protectedHeader: JWSHeaderParameters, token: FlattenedJWSInput): Promise<KeyLike>;
 }
 /**
- * Returns a function that resolves to a key object from a locally
- * stored, or otherwise available, JSON Web Key Set.
+ * Returns a function that resolves to a key object from a locally stored, or otherwise available,
+ * JSON Web Key Set.
  *
  * Only a single public key must match the selection process.
  *
- * @param jwks JSON Web Key Set formatted object.
- *
  * @example Usage
+ *
  * ```js
  * const JWKS = jose.createLocalJWKSet({
  *   keys: [
@@ -28,24 +23,26 @@ export declare class LocalJWKSet {
  *       kty: 'RSA',
  *       e: 'AQAB',
  *       n: '12oBZRhCiZFJLcPg59LkZZ9mdhSMTKAQZYq32k_ti5SBB6jerkh-WzOMAO664r_qyLkqHUSp3u5SbXtseZEpN3XPWGKSxjsy-1JyEFTdLSYe6f9gfrmxkUF_7DTpq0gn6rntP05g2-wFW50YO7mosfdslfrTJYWHFhJALabAeYirYD7-9kqq9ebfFMF4sRRELbv9oi36As6Q9B3Qb5_C1rAzqfao_PCsf9EPsTZsVVVkA5qoIAr47lo1ipfiBPxUCCNSdvkmDTYgvvRm6ZoMjFbvOtgyts55fXKdMWv7I9HMD5HwE9uW839PWA514qhbcIsXEYSFMPMV6fnlsiZvQQ',
- *       alg: 'PS256'
+ *       alg: 'PS256',
  *     },
  *     {
  *       crv: 'P-256',
  *       kty: 'EC',
  *       x: 'ySK38C1jBdLwDsNWKzzBHqKYEE5Cgv-qjWvorUXk9fw',
  *       y: '_LeQBw07cf5t57Iavn4j-BqJsAD1dpoz8gokd3sBsOo',
- *       alg: 'ES256'
- *     }
- *   ]
+ *       alg: 'ES256',
+ *     },
+ *   ],
  * })
  *
  * const { payload, protectedHeader } = await jose.jwtVerify(jwt, JWKS, {
  *   issuer: 'urn:example:issuer',
- *   audience: 'urn:example:audience'
+ *   audience: 'urn:example:audience',
  * })
  * console.log(protectedHeader)
  * console.log(payload)
  * ```
+ *
+ * @param jwks JSON Web Key Set formatted object.
  */
 export declare function createLocalJWKSet(jwks: JSONWebKeySet): GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput>;

package/dist/types/jwks/remote.d.ts

@@ -1,68 +1,54 @@
 import type { JWSHeaderParameters, FlattenedJWSInput, GetKeyFunction } from '../types';
-/**
- * Options for the remote JSON Web Key Set.
- */
+/** Options for the remote JSON Web Key Set. */
 export interface RemoteJWKSetOptions {
     /**
-     * Timeout (in milliseconds) for the HTTP request. When reached the request
-     * will be aborted and the verification will fail. Default is 5000 (5
-     * seconds).
+     * Timeout (in milliseconds) for the HTTP request. When reached the request will be aborted and
+     * the verification will fail. Default is 5000 (5 seconds).
      */
     timeoutDuration?: number;
     /**
-     * Duration (in milliseconds) for which no more HTTP requests will be
-     * triggered after a previous successful fetch. Default is 30000 (30 seconds).
+     * Duration (in milliseconds) for which no more HTTP requests will be triggered after a previous
+     * successful fetch. Default is 30000 (30 seconds).
      */
     cooldownDuration?: number;
-    /**
-     * Maximum time (in milliseconds) between successful HTTP requests. Default is
-     * 600000 (10 minutes).
-     */
+    /** Maximum time (in milliseconds) between successful HTTP requests. Default is 600000 (10 minutes). */
     cacheMaxAge?: number | typeof Infinity;
     /**
-     * An instance of
-     * [http.Agent](https://nodejs.org/api/http.html#http_class_http_agent) or
-     * [https.Agent](https://nodejs.org/api/https.html#https_class_https_agent) to
-     * pass to the
-     * [http.get](https://nodejs.org/api/http.html#http_http_get_options_callback)
-     * or
-     * [https.get](https://nodejs.org/api/https.html#https_https_get_options_callback)
-     * method's options. Use when behind an http(s) proxy. This is a Node.js
-     * runtime specific option, it is ignored when used outside of Node.js
-     * runtime.
+     * An instance of [http.Agent](https://nodejs.org/api/http.html#class-httpagent) or
+     * [https.Agent](https://nodejs.org/api/https.html#class-httpsagent) to pass to the
+     * [http.get](https://nodejs.org/api/http.html#httpgetoptions-callback) or
+     * [https.get](https://nodejs.org/api/https.html#httpsgetoptions-callback) method's options. Use
+     * when behind an http(s) proxy. This is a Node.js runtime specific option, it is ignored when
+     * used outside of Node.js runtime.
      */
     agent?: any;
-    /**
-     * Optional headers to be sent with the HTTP request.
-     */
+    /** Optional headers to be sent with the HTTP request. */
     headers?: Record<string, string>;
 }
 interface URL {
     href: string;
 }
 /**
- * Returns a function that resolves to a key object downloaded from a
- * remote endpoint returning a JSON Web Key Set, that is, for example,
- * an OAuth 2.0 or OIDC jwks_uri. Only a single public key must match
- * the selection process.
- * The JSON Web Key Set is fetched when no key matches the selection
- * process but only as frequently as the `cooldownDuration` option allows,
- * to prevent abuse.
- *
- * @param url URL to fetch the JSON Web Key Set from.
- * @param options Options for the remote JSON Web Key Set.
+ * Returns a function that resolves to a key object downloaded from a remote endpoint returning a
+ * JSON Web Key Set, that is, for example, an OAuth 2.0 or OIDC jwks_uri. Only a single public key
+ * must match the selection process. The JSON Web Key Set is fetched when no key matches the
+ * selection process but only as frequently as the `cooldownDuration` option allows, to prevent abuse.
  *
  * @example Usage
+ *
  * ```js
  * const JWKS = jose.createRemoteJWKSet(new URL('https://www.googleapis.com/oauth2/v3/certs'))
  *
  * const { payload, protectedHeader } = await jose.jwtVerify(jwt, JWKS, {
  *   issuer: 'urn:example:issuer',
- *   audience: 'urn:example:audience'
+ *   audience: 'urn:example:audience',
  * })
  * console.log(protectedHeader)
  * console.log(payload)
  * ```
+ *
+ * @param url URL to fetch the JSON Web Key Set from.
+ * @param options Options for the remote JSON Web Key Set.
  */
 export declare function createRemoteJWKSet(url: URL, options?: RemoteJWKSetOptions): GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput>;
 export {};

package/dist/types/jws/compact/sign.d.ts

@@ -3,11 +3,10 @@ import type { CompactJWSHeaderParameters, KeyLike, SignOptions } from '../../typ
  * The CompactSign class is a utility for creating Compact JWS strings.
  *
  * @example Usage
+ *
  * ```js
  * const jws = await new jose.CompactSign(
- *   new TextEncoder().encode(
- *     'It’s a dangerous business, Frodo, going out your door.'
- *   )
+ *   new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
  * )
  *   .setProtectedHeader({ alg: 'ES256' })
  *   .sign(privateKey)
@@ -17,9 +16,7 @@ import type { CompactJWSHeaderParameters, KeyLike, SignOptions } from '../../typ
  */
 export declare class CompactSign {
     private _flattened;
-    /**
-     * @param payload Binary representation of the payload to sign.
-     */
+    /** @param payload Binary representation of the payload to sign. */
     constructor(payload: Uint8Array);
     /**
      * Sets the JWS Protected Header on the Sign object.

package/dist/types/jws/compact/verify.d.ts

@@ -1,9 +1,10 @@
 import type { CompactVerifyResult, FlattenedJWSInput, GetKeyFunction, CompactJWSHeaderParameters, KeyLike, VerifyOptions, ResolvedKey } from '../../types';
 /**
- * Interface for Compact JWS Verification dynamic key resolution.
- * No token components have been verified at the time of this function call.
+ * Interface for Compact JWS Verification dynamic key resolution. No token components have been
+ * verified at the time of this function call.
  *
- * See [createRemoteJWKSet](../functions/jwks_remote.createRemoteJWKSet.md#function-createremotejwkset)
+ * See
+ * [createRemoteJWKSet](../functions/jwks_remote.createRemoteJWKSet.md#function-createremotejwkset)
  * to verify using a remote JSON Web Key Set.
  */
 export interface CompactVerifyGetKey extends GetKeyFunction<CompactJWSHeaderParameters, FlattenedJWSInput> {
@@ -11,19 +12,21 @@ export interface CompactVerifyGetKey extends GetKeyFunction<CompactJWSHeaderPara
 /**
  * Verifies the signature and format of and afterwards decodes the Compact JWS.
  *
- * @param jws Compact JWS.
- * @param key Key to verify the JWS with.
- * @param options JWS Verify options.
- *
  * @example Usage
+ *
  * ```js
- * const jws = 'eyJhbGciOiJFUzI1NiJ9.SXTigJlzIGEgZGFuZ2Vyb3VzIGJ1c2luZXNzLCBGcm9kbywgZ29pbmcgb3V0IHlvdXIgZG9vci4.kkAs_gPPxWMI3rHuVlxHaTPfDWDoqdI8jSvuSmqV-8IHIWXg9mcAeC9ggV-45ZHRbiRJ3obUIFo1rHphPA5URg'
+ * const jws =
+ *   'eyJhbGciOiJFUzI1NiJ9.SXTigJlzIGEgZGFuZ2Vyb3VzIGJ1c2luZXNzLCBGcm9kbywgZ29pbmcgb3V0IHlvdXIgZG9vci4.kkAs_gPPxWMI3rHuVlxHaTPfDWDoqdI8jSvuSmqV-8IHIWXg9mcAeC9ggV-45ZHRbiRJ3obUIFo1rHphPA5URg'
  *
  * const { payload, protectedHeader } = await jose.compactVerify(jws, publicKey)
  *
  * console.log(protectedHeader)
  * console.log(new TextDecoder().decode(payload))
  * ```
+ *
+ * @param jws Compact JWS.
+ * @param key Key to verify the JWS with.
+ * @param options JWS Verify options.
  */
 export declare function compactVerify(jws: string | Uint8Array, key: KeyLike | Uint8Array, options?: VerifyOptions): Promise<CompactVerifyResult>;
 /**

package/dist/types/jws/flattened/sign.d.ts

@@ -3,11 +3,10 @@ import type { KeyLike, FlattenedJWS, JWSHeaderParameters, SignOptions } from '..
  * The FlattenedSign class is a utility for creating Flattened JWS objects.
  *
  * @example Usage
+ *
  * ```js
  * const jws = await new jose.FlattenedSign(
- *   new TextEncoder().encode(
- *     'It’s a dangerous business, Frodo, going out your door.'
- *   )
+ *   new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
  * )
  *   .setProtectedHeader({ alg: 'ES256' })
  *   .sign(privateKey)
@@ -19,9 +18,7 @@ export declare class FlattenedSign {
     private _payload;
     private _protectedHeader;
     private _unprotectedHeader;
-    /**
-     * @param payload Binary representation of the payload to sign.
-     */
+    /** @param payload Binary representation of the payload to sign. */
     constructor(payload: Uint8Array);
     /**
      * Sets the JWS Protected Header on the FlattenedSign object.

package/dist/types/jws/flattened/verify.d.ts

@@ -1,9 +1,10 @@
 import type { FlattenedVerifyResult, KeyLike, FlattenedJWSInput, JWSHeaderParameters, VerifyOptions, GetKeyFunction, ResolvedKey } from '../../types';
 /**
- * Interface for Flattened JWS Verification dynamic key resolution.
- * No token components have been verified at the time of this function call.
+ * Interface for Flattened JWS Verification dynamic key resolution. No token components have been
+ * verified at the time of this function call.
  *
- * See [createRemoteJWKSet](../functions/jwks_remote.createRemoteJWKSet.md#function-createremotejwkset)
+ * See
+ * [createRemoteJWKSet](../functions/jwks_remote.createRemoteJWKSet.md#function-createremotejwkset)
  * to verify using a remote JSON Web Key Set.
  */
 export interface FlattenedVerifyGetKey extends GetKeyFunction<JWSHeaderParameters | undefined, FlattenedJWSInput> {
@@ -11,17 +12,15 @@ export interface FlattenedVerifyGetKey extends GetKeyFunction<JWSHeaderParameter
 /**
  * Verifies the signature and format of and afterwards decodes the Flattened JWS.
  *
- * @param jws Flattened JWS.
- * @param key Key to verify the JWS with.
- * @param options JWS Verify options.
- *
  * @example Usage
+ *
  * ```js
  * const decoder = new TextDecoder()
  * const jws = {
- *   signature: 'FVVOXwj6kD3DqdfD9yYqfT2W9jv-Nop4kOehp_DeDGNB5dQNSPRvntBY6xH3uxlCxE8na9d_kyhYOcanpDJ0EA',
+ *   signature:
+ *     'FVVOXwj6kD3DqdfD9yYqfT2W9jv-Nop4kOehp_DeDGNB5dQNSPRvntBY6xH3uxlCxE8na9d_kyhYOcanpDJ0EA',
  *   payload: 'SXTigJlzIGEgZGFuZ2Vyb3VzIGJ1c2luZXNzLCBGcm9kbywgZ29pbmcgb3V0IHlvdXIgZG9vci4',
- *   protected: 'eyJhbGciOiJFUzI1NiJ9'
+ *   protected: 'eyJhbGciOiJFUzI1NiJ9',
  * }
  *
  * const { payload, protectedHeader } = await jose.flattenedVerify(jws, publicKey)
@@ -29,6 +28,10 @@ export interface FlattenedVerifyGetKey extends GetKeyFunction<JWSHeaderParameter
  * console.log(protectedHeader)
  * console.log(decoder.decode(payload))
  * ```
+ *
+ * @param jws Flattened JWS.
+ * @param key Key to verify the JWS with.
+ * @param options JWS Verify options.
  */
 export declare function flattenedVerify(jws: FlattenedJWSInput, key: KeyLike | Uint8Array, options?: VerifyOptions): Promise<FlattenedVerifyResult>;
 /**

package/dist/types/jws/general/sign.d.ts

@@ -12,28 +12,21 @@ export interface Signature {
      * @param unprotectedHeader JWS Unprotected Header.
      */
     setUnprotectedHeader(unprotectedHeader: JWSHeaderParameters): Signature;
-    /**
-     * A shorthand for calling addSignature() on the enclosing GeneralSign instance
-     */
+    /** A shorthand for calling addSignature() on the enclosing GeneralSign instance */
     addSignature(...args: Parameters<GeneralSign['addSignature']>): Signature;
-    /**
-     * A shorthand for calling encrypt() on the enclosing GeneralSign instance
-     */
+    /** A shorthand for calling encrypt() on the enclosing GeneralSign instance */
     sign(...args: Parameters<GeneralSign['sign']>): Promise<GeneralJWS>;
-    /**
-     * Returns the enclosing GeneralSign
-     */
+    /** Returns the enclosing GeneralSign */
     done(): GeneralSign;
 }
 /**
  * The GeneralSign class is a utility for creating General JWS objects.
  *
  * @example Usage
+ *
  * ```js
  * const jws = await new jose.GeneralSign(
- *   new TextEncoder().encode(
- *     'It’s a dangerous business, Frodo, going out your door.'
- *   )
+ *   new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
  * )
  *   .addSignature(ecPrivateKey)
  *   .setProtectedHeader({ alg: 'ES256' })
@@ -47,9 +40,7 @@ export interface Signature {
 export declare class GeneralSign {
     private _payload;
     private _signatures;
-    /**
-     * @param payload Binary representation of the payload to sign.
-     */
+    /** @param payload Binary representation of the payload to sign. */
     constructor(payload: Uint8Array);
     /**
      * Adds an additional signature for the General JWS object.
@@ -58,8 +49,6 @@ export declare class GeneralSign {
      * @param options JWS Sign options.
      */
     addSignature(key: KeyLike | Uint8Array, options?: SignOptions): Signature;
-    /**
-     * Signs and resolves the value of the General JWS object.
-     */
+    /** Signs and resolves the value of the General JWS object. */
     sign(): Promise<GeneralJWS>;
 }

package/dist/types/jws/general/verify.d.ts

@@ -1,9 +1,10 @@
 import type { GeneralJWSInput, GeneralVerifyResult, FlattenedJWSInput, GetKeyFunction, JWSHeaderParameters, KeyLike, VerifyOptions, ResolvedKey } from '../../types';
 /**
- * Interface for General JWS Verification dynamic key resolution.
- * No token components have been verified at the time of this function call.
+ * Interface for General JWS Verification dynamic key resolution. No token components have been
+ * verified at the time of this function call.
  *
- * See [createRemoteJWKSet](../functions/jwks_remote.createRemoteJWKSet.md#function-createremotejwkset)
+ * See
+ * [createRemoteJWKSet](../functions/jwks_remote.createRemoteJWKSet.md#function-createremotejwkset)
  * to verify using a remote JSON Web Key Set.
  */
 export interface GeneralVerifyGetKey extends GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput> {
@@ -11,20 +12,18 @@ export interface GeneralVerifyGetKey extends GetKeyFunction<JWSHeaderParameters,
 /**
  * Verifies the signature and format of and afterwards decodes the General JWS.
  *
- * @param jws General JWS.
- * @param key Key to verify the JWS with.
- * @param options JWS Verify options.
- *
  * @example Usage
+ *
  * ```js
  * const jws = {
  *   payload: 'SXTigJlzIGEgZGFuZ2Vyb3VzIGJ1c2luZXNzLCBGcm9kbywgZ29pbmcgb3V0IHlvdXIgZG9vci4',
  *   signatures: [
  *     {
- *       signature: 'FVVOXwj6kD3DqdfD9yYqfT2W9jv-Nop4kOehp_DeDGNB5dQNSPRvntBY6xH3uxlCxE8na9d_kyhYOcanpDJ0EA',
- *       protected: 'eyJhbGciOiJFUzI1NiJ9'
- *     }
- *   ]
+ *       signature:
+ *         'FVVOXwj6kD3DqdfD9yYqfT2W9jv-Nop4kOehp_DeDGNB5dQNSPRvntBY6xH3uxlCxE8na9d_kyhYOcanpDJ0EA',
+ *       protected: 'eyJhbGciOiJFUzI1NiJ9',
+ *     },
+ *   ],
  * }
  *
  * const { payload, protectedHeader } = await jose.generalVerify(jws, publicKey)
@@ -32,6 +31,10 @@ export interface GeneralVerifyGetKey extends GetKeyFunction<JWSHeaderParameters,
  * console.log(protectedHeader)
  * console.log(new TextDecoder().decode(payload))
  * ```
+ *
+ * @param jws General JWS.
+ * @param key Key to verify the JWS with.
+ * @param options JWS Verify options.
  */
 export declare function generalVerify(jws: GeneralJWSInput, key: KeyLike | Uint8Array, options?: VerifyOptions): Promise<GeneralVerifyResult>;
 /**

package/dist/types/jwt/decrypt.d.ts

@@ -1,34 +1,35 @@
 import type { KeyLike, DecryptOptions, JWTClaimVerificationOptions, GetKeyFunction, CompactJWEHeaderParameters, FlattenedJWE, JWTDecryptResult, ResolvedKey } from '../types';
-/**
- * Combination of JWE Decryption options and JWT Claims Set verification options.
- */
+/** Combination of JWE Decryption options and JWT Claims Set verification options. */
 export interface JWTDecryptOptions extends DecryptOptions, JWTClaimVerificationOptions {
 }
 /**
- * Interface for JWT Decryption dynamic key resolution.
- * No token components have been verified at the time of this function call.
+ * Interface for JWT Decryption dynamic key resolution. No token components have been verified at
+ * the time of this function call.
  */
 export interface JWTDecryptGetKey extends GetKeyFunction<CompactJWEHeaderParameters, FlattenedJWE> {
 }
 /**
- * Verifies the JWT format (to be a JWE Compact format), decrypts the ciphertext, validates the JWT Claims Set.
- *
- * @param jwt JSON Web Token value (encoded as JWE).
- * @param key Private Key or Secret to decrypt and verify the JWT with.
- * @param options JWT Decryption and JWT Claims Set validation options.
+ * Verifies the JWT format (to be a JWE Compact format), decrypts the ciphertext, validates the JWT
+ * Claims Set.
  *
  * @example Usage
+ *
  * ```js
- * const jwt = 'eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..KVcNLqK-3-8ZkYIC.xSwF4VxO0kUMUD2W-cifsNUxnr-swyBq-nADBptyt6y9n79-iNc5b0AALJpRwc0wwDkJw8hNOMjApNUTMsK9b-asToZ3DXFMvwfJ6n1aWefvd7RsoZ2LInWFfVAuttJDzoGB.uuexQoWHwrLMEYRElT8pBQ'
+ * const jwt =
+ *   'eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..KVcNLqK-3-8ZkYIC.xSwF4VxO0kUMUD2W-cifsNUxnr-swyBq-nADBptyt6y9n79-iNc5b0AALJpRwc0wwDkJw8hNOMjApNUTMsK9b-asToZ3DXFMvwfJ6n1aWefvd7RsoZ2LInWFfVAuttJDzoGB.uuexQoWHwrLMEYRElT8pBQ'
  *
  * const { payload, protectedHeader } = await jose.jwtDecrypt(jwt, secretKey, {
  *   issuer: 'urn:example:issuer',
- *   audience: 'urn:example:audience'
+ *   audience: 'urn:example:audience',
  * })
  *
  * console.log(protectedHeader)
  * console.log(payload)
  * ```
+ *
+ * @param jwt JSON Web Token value (encoded as JWE).
+ * @param key Private Key or Secret to decrypt and verify the JWT with.
+ * @param options JWT Decryption and JWT Claims Set validation options.
  */
 export declare function jwtDecrypt(jwt: string | Uint8Array, key: KeyLike | Uint8Array, options?: JWTDecryptOptions): Promise<JWTDecryptResult>;
 /**

package/dist/types/jwt/encrypt.d.ts

@@ -4,6 +4,7 @@ import { ProduceJWT } from './produce';
  * The EncryptJWT class is a utility for creating Compact JWE formatted JWT strings.
  *
  * @example Usage
+ *
  * ```js
  * const jwt = await new jose.EncryptJWT({ 'urn:example:claim': true })
  *   .setProtectedHeader({ alg: 'dir', enc: 'A256GCM' })
@@ -27,39 +28,35 @@ export declare class EncryptJWT extends ProduceJWT {
     /**
      * Sets the JWE Protected Header on the EncryptJWT object.
      *
-     * @param protectedHeader JWE Protected Header.
-     * Must contain an "alg" (JWE Algorithm) and "enc" (JWE
-     * Encryption Algorithm) properties.
+     * @param protectedHeader JWE Protected Header. Must contain an "alg" (JWE Algorithm) and "enc"
+     *   (JWE Encryption Algorithm) properties.
      */
     setProtectedHeader(protectedHeader: CompactJWEHeaderParameters): this;
     /**
-     * Sets the JWE Key Management parameters to be used when encrypting.
-     * Use of this is method is really only needed for ECDH based algorithms
-     * when utilizing the Agreement PartyUInfo or Agreement PartyVInfo parameters.
-     * Other parameters will always be randomly generated when needed and missing.
+     * Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is
+     * really only needed for ECDH based algorithms when utilizing the Agreement PartyUInfo or
+     * Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed
+     * and missing.
      *
      * @param parameters JWE Key Management parameters.
      */
     setKeyManagementParameters(parameters: JWEKeyManagementHeaderParameters): this;
     /**
-     * Sets a content encryption key to use, by default a random suitable one
-     * is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
+     * 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.
      * @param cek JWE Content Encryption Key.
-     *
-     * @deprecated You should not use this method. It is only really intended
-     * for test and vector validation purposes.
      */
     setContentEncryptionKey(cek: Uint8Array): this;
     /**
-     * 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.
+     * 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.
      * @param iv JWE Initialization Vector.
-     *
-     * @deprecated You should not use this method. It is only really intended
-     * for test and vector validation purposes.
      */
     setInitializationVector(iv: Uint8Array): this;
     /**

package/dist/types/jwt/produce.d.ts

@@ -1,12 +1,8 @@
 import type { JWTPayload } from '../types';
-/**
- * Generic class for JWT producing.
- */
+/** Generic class for JWT producing. */
 export declare class ProduceJWT {
     protected _payload: JWTPayload;
-    /**
-     * @param payload The JWT Claims Set object.
-     */
+    /** @param payload The JWT Claims Set object. */
     constructor(payload: JWTPayload);
     /**
      * Set "iss" (Issuer) Claim.
@@ -35,24 +31,23 @@ export declare class ProduceJWT {
     /**
      * Set "nbf" (Not Before) Claim.
      *
-     * @param input "nbf" (Not Before) Claim value to set on the JWT Claims Set.
-     * When number is passed that is used as a value, when string is passed
-     * it is resolved to a time span and added to the current timestamp.
+     * @param input "nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed
+     *   that is used as a value, when string is passed it is resolved to a time span and added to the
+     *   current timestamp.
      */
     setNotBefore(input: number | string): this;
     /**
      * Set "exp" (Expiration Time) Claim.
      *
-     * @param input "exp" (Expiration Time) Claim value to set on the JWT Claims Set.
-     * When number is passed that is used as a value, when string is passed
-     * it is resolved to a time span and added to the current timestamp.
+     * @param input "exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is
+     *   passed that is used as a value, when string is passed it is resolved to a time span and added
+     *   to the current timestamp.
      */
     setExpirationTime(input: number | string): this;
     /**
      * Set "iat" (Issued At) Claim.
      *
-     * @param input "iat" (Issued At) Claim value to set on the JWT Claims Set.
-     * Default is current timestamp.
+     * @param input "iat" (Issued At) Claim value to set on the JWT Claims Set. Default is current timestamp.
      */
     setIssuedAt(input?: number): this;
 }

package/dist/types/jwt/sign.d.ts

@@ -4,6 +4,7 @@ import { ProduceJWT } from './produce';
  * The SignJWT class is a utility for creating Compact JWS formatted JWT strings.
  *
  * @example Usage
+ *
  * ```js
  * const jwt = await new jose.SignJWT({ 'urn:example:claim': true })
  *   .setProtectedHeader({ alg: 'ES256' })
@@ -21,8 +22,7 @@ export declare class SignJWT extends ProduceJWT {
     /**
      * Sets the JWS Protected Header on the SignJWT object.
      *
-     * @param protectedHeader JWS Protected Header.
-     * Must contain an "alg" (JWS Algorithm) property.
+     * @param protectedHeader JWS Protected Header. Must contain an "alg" (JWS Algorithm) property.
      */
     setProtectedHeader(protectedHeader: JWTHeaderParameters): this;
     /**

package/dist/types/jwt/unsecured.d.ts

@@ -8,6 +8,7 @@ export interface UnsecuredResult {
  * The UnsecuredJWT class is a utility for dealing with `{ "alg": "none" }` Unsecured JWTs.
  *
  * @example Encoding
+ *
  * ```js
  * const unsecuredJwt = new jose.UnsecuredJWT({ 'urn:example:claim': true })
  *   .setIssuedAt()
@@ -20,19 +21,18 @@ export interface UnsecuredResult {
  * ```
  *
  * @example Decoding
+ *
  * ```js
  * const payload = jose.UnsecuredJWT.decode(jwt, {
  *   issuer: 'urn:example:issuer',
- *   audience: 'urn:example:audience'
+ *   audience: 'urn:example:audience',
  * })
  *
  * console.log(payload)
  * ```
  */
 export declare class UnsecuredJWT extends ProduceJWT {
-    /**
-     * Encodes the Unsecured JWT.
-     */
+    /** Encodes the Unsecured JWT. */
     encode(): string;
     /**
      * Decodes an unsecured JWT.