jose 4.8.3 → 4.9.2

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.

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

@@ -1,37 +1,39 @@
 import type { KeyLike, VerifyOptions, JWTClaimVerificationOptions, JWTHeaderParameters, GetKeyFunction, FlattenedJWSInput, JWTVerifyResult, ResolvedKey } from '../types';
-/**
- * Combination of JWS Verification options and JWT Claims Set verification options.
- */
+/** Combination of JWS Verification options and JWT Claims Set verification options. */
 export interface JWTVerifyOptions extends VerifyOptions, JWTClaimVerificationOptions {
 }
 /**
- * Interface for JWT Verification dynamic key resolution.
- * No token components have been verified at the time of this function call.
+ * Interface for JWT 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 JWTVerifyGetKey extends GetKeyFunction<JWTHeaderParameters, FlattenedJWSInput> {
 }
 /**
- * Verifies the JWT format (to be a JWS Compact format), verifies the JWS signature, validates the JWT Claims Set.
- *
- * @param jwt JSON Web Token value (encoded as JWS).
- * @param key Key to verify the JWT with.
- * @param options JWT Decryption and JWT Claims Set validation options.
+ * Verifies the JWT format (to be a JWS Compact format), verifies the JWS signature, validates the
+ * JWT Claims Set.
  *
  * @example Usage
+ *
  * ```js
- * const jwt = 'eyJhbGciOiJFUzI1NiJ9.eyJ1cm46ZXhhbXBsZTpjbGFpbSI6dHJ1ZSwiaWF0IjoxNjA0MzE1MDc0LCJpc3MiOiJ1cm46ZXhhbXBsZTppc3N1ZXIiLCJhdWQiOiJ1cm46ZXhhbXBsZTphdWRpZW5jZSJ9.hx1nOfAT5LlXuzu8O-bhjXBGpklWDt2EsHw7-MDn49NrnwvVsstNhEnkW2ddauB7eSikFtUNeumLpFI9CWDBsg'
+ * const jwt =
+ *   'eyJhbGciOiJFUzI1NiJ9.eyJ1cm46ZXhhbXBsZTpjbGFpbSI6dHJ1ZSwiaWF0IjoxNjA0MzE1MDc0LCJpc3MiOiJ1cm46ZXhhbXBsZTppc3N1ZXIiLCJhdWQiOiJ1cm46ZXhhbXBsZTphdWRpZW5jZSJ9.hx1nOfAT5LlXuzu8O-bhjXBGpklWDt2EsHw7-MDn49NrnwvVsstNhEnkW2ddauB7eSikFtUNeumLpFI9CWDBsg'
  *
  * const { payload, protectedHeader } = await jose.jwtVerify(jwt, publicKey, {
  *   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 JWS).
+ * @param key Key to verify the JWT with.
+ * @param options JWT Decryption and JWT Claims Set validation options.
  */
 export declare function jwtVerify(jwt: string | Uint8Array, key: KeyLike | Uint8Array, options?: JWTVerifyOptions): Promise<JWTVerifyResult>;
 /**

package/dist/types/key/export.d.ts

@@ -1,36 +1,39 @@
 import type { JWK, KeyLike } from '../types';
 /**
- * Exports a runtime-specific public key representation (KeyObject or CryptoKey) to a PEM-encoded SPKI string format.
- *
- * @param key Key representation to transform to a PEM-encoded SPKI string format.
+ * Exports a runtime-specific public key representation (KeyObject or CryptoKey) to a PEM-encoded
+ * SPKI string format.
  *
  * @example Usage
+ *
  * ```js
  * const spkiPem = await jose.exportSPKI(publicKey)
  *
  * console.log(spkiPem)
  * ```
+ *
+ * @param key Key representation to transform to a PEM-encoded SPKI string format.
  */
 export declare function exportSPKI(key: KeyLike): Promise<string>;
 /**
- * Exports a runtime-specific private key representation (KeyObject or CryptoKey) to a PEM-encoded PKCS8 string format.
- *
- * @param key Key representation to transform to a PEM-encoded PKCS8 string format.
+ * Exports a runtime-specific private key representation (KeyObject or CryptoKey) to a PEM-encoded
+ * PKCS8 string format.
  *
  * @example Usage
+ *
  * ```js
  * const pkcs8Pem = await jose.exportPKCS8(privateKey)
  *
  * console.log(pkcs8Pem)
  * ```
+ *
+ * @param key Key representation to transform to a PEM-encoded PKCS8 string format.
  */
 export declare function exportPKCS8(key: KeyLike): Promise<string>;
 /**
  * Exports a runtime-specific key representation (KeyLike) to a JWK.
  *
- * @param key Key representation to export as JWK.
- *
  * @example Usage
+ *
  * ```js
  * const privateJwk = await jose.exportJWK(privateKey)
  * const publicJwk = await jose.exportJWK(publicKey)
@@ -38,5 +41,7 @@ export declare function exportPKCS8(key: KeyLike): Promise<string>;
  * console.log(privateJwk)
  * console.log(publicJwk)
  * ```
+ *
+ * @param key Key representation to export as JWK.
  */
 export declare function exportJWK(key: KeyLike | Uint8Array): Promise<JWK>;

package/dist/types/key/generate_key_pair.d.ts

@@ -1,24 +1,19 @@
 import type { KeyLike } from '../types';
 export interface GenerateKeyPairResult {
-    /**
-     * The generated Private Key.
-     */
+    /** The generated Private Key. */
     privateKey: KeyLike;
-    /**
-     * Public Key corresponding to the generated Private Key.
-     */
+    /** Public Key corresponding to the generated Private Key. */
     publicKey: KeyLike;
 }
 export interface GenerateKeyPairOptions {
     /**
-     * The EC "crv" (Curve) or OKP "crv" (Subtype of Key Pair) value to generate.
-     * The curve must be both supported on the runtime as well as applicable for
-     * the given JWA algorithm identifier.
+     * The EC "crv" (Curve) or OKP "crv" (Subtype of Key Pair) value to generate. The curve must be
+     * both supported on the runtime as well as applicable for the given JWA algorithm identifier.
      */
     crv?: string;
     /**
-     * A hint for RSA algorithms to generate an RSA key of a given `modulusLength`
-     * (Key size in bits). JOSE requires 2048 bits or larger. Default is 2048.
+     * A hint for RSA algorithms to generate an RSA key of a given `modulusLength` (Key size in bits).
+     * JOSE requires 2048 bits or larger. Default is 2048.
      */
     modulusLength?: number;
     /**
@@ -29,21 +24,21 @@ export interface GenerateKeyPairOptions {
     extractable?: boolean;
 }
 /**
- * Generates a private and a public key for a given JWA algorithm identifier.
- * This can only generate asymmetric key pairs. For symmetric secrets use the
- * `generateSecret` function.
+ * Generates a private and a public key for a given JWA algorithm identifier. This can only generate
+ * asymmetric key pairs. For symmetric secrets use the `generateSecret` function.
  *
- * Note: Under Web Cryptography API runtime the `privateKey` is generated with
- * `extractable` set to `false` by default.
- *
- * @param alg JWA Algorithm Identifier to be used with the generated key pair.
- * @param options Additional options passed down to the key pair generation.
+ * Note: Under Web Cryptography API runtime the `privateKey` is generated with `extractable` set to
+ * `false` by default.
  *
  * @example Usage
+ *
  * ```js
  * const { publicKey, privateKey } = await jose.generateKeyPair('PS256')
  * console.log(publicKey)
  * console.log(privateKey)
  * ```
+ *
+ * @param alg JWA Algorithm Identifier to be used with the generated key pair.
+ * @param options Additional options passed down to the key pair generation.
  */
 export declare function generateKeyPair(alg: string, options?: GenerateKeyPairOptions): Promise<GenerateKeyPairResult>;

package/dist/types/key/generate_secret.d.ts

@@ -10,10 +10,11 @@ export interface GenerateSecretOptions {
 /**
  * Generates a symmetric secret key for a given JWA algorithm identifier.
  *
- * Note: Under Web Cryptography API runtime the secret key is generated with
- * `extractable` set to `false` by default.
+ * Note: Under Web Cryptography API runtime the secret key is generated with `extractable` set to
+ * `false` by default.
  *
  * @example Usage
+ *
  * ```js
  * const secret = await jose.generateSecret('HS256')
  * console.log(secret)

package/dist/types/key/import.d.ts

@@ -8,14 +8,12 @@ export interface PEMImportOptions {
     extractable?: boolean;
 }
 /**
- * Imports a PEM-encoded SPKI string as a runtime-specific public key representation (KeyObject or CryptoKey).
- * See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210) to learn about key to algorithm
- * requirements and mapping.
- *
- * @param pem PEM-encoded SPKI string
- * @param alg JSON Web Algorithm identifier to be used with the imported key.
+ * Imports a PEM-encoded SPKI string as a runtime-specific public key representation (KeyObject or
+ * CryptoKey). See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210) to learn
+ * about key to algorithm requirements and mapping.
  *
  * @example Usage
+ *
  * ```js
  * const algorithm = 'ES256'
  * const spki = `-----BEGIN PUBLIC KEY-----
@@ -24,17 +22,19 @@ export interface PEMImportOptions {
  * -----END PUBLIC KEY-----`
  * const ecPublicKey = await jose.importSPKI(spki, algorithm)
  * ```
+ *
+ * @param pem PEM-encoded SPKI string
+ * @param alg JSON Web Algorithm identifier to be used with the imported key.
  */
 export declare function importSPKI(spki: string, alg: string, options?: PEMImportOptions): Promise<KeyLike>;
 /**
- * Imports the SPKI from an X.509 string certificate as a runtime-specific public key representation (KeyObject or CryptoKey).
- * See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210) to learn about key to algorithm
+ * Imports the SPKI from an X.509 string certificate as a runtime-specific public key representation
+ * (KeyObject or CryptoKey). See [Algorithm Key
+ * Requirements](https://github.com/panva/jose/issues/210) to learn about key to algorithm
  * requirements and mapping.
  *
- * @param pem X.509 certificate string
- * @param alg JSON Web Algorithm identifier to be used with the imported key.
- *
  * @example Usage
+ *
  * ```js
  * const algorithm = 'ES256'
  * const x509 = `-----BEGIN CERTIFICATE-----
@@ -49,17 +49,18 @@ export declare function importSPKI(spki: string, alg: string, options?: PEMImpor
  * -----END CERTIFICATE-----`
  * const ecPublicKey = await jose.importX509(x509, algorithm)
  * ```
+ *
+ * @param pem X.509 certificate string
+ * @param alg JSON Web Algorithm identifier to be used with the imported key.
  */
 export declare function importX509(x509: string, alg: string, options?: PEMImportOptions): Promise<KeyLike>;
 /**
- * Imports a PEM-encoded PKCS8 string as a runtime-specific private key representation (KeyObject or CryptoKey).
- * See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210) to learn about key to algorithm
- * requirements and mapping. Encrypted keys are not supported.
- *
- * @param pem PEM-encoded PKCS8 string
- * @param alg JSON Web Algorithm identifier to be used with the imported key.
+ * Imports a PEM-encoded PKCS8 string as a runtime-specific private key representation (KeyObject or
+ * CryptoKey). See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210) to learn
+ * about key to algorithm requirements and mapping. Encrypted keys are not supported.
  *
  * @example Usage
+ *
  * ```js
  * const algorithm = 'ES256'
  * const pkcs8 = `-----BEGIN PRIVATE KEY-----
@@ -69,36 +70,46 @@ export declare function importX509(x509: string, alg: string, options?: PEMImpor
  * -----END PRIVATE KEY-----`
  * const ecPrivateKey = await jose.importPKCS8(pkcs8, algorithm)
  * ```
+ *
+ * @param pem PEM-encoded PKCS8 string
+ * @param alg JSON Web Algorithm identifier to be used with the imported key.
  */
 export declare function importPKCS8(pkcs8: string, alg: string, options?: PEMImportOptions): Promise<KeyLike>;
 /**
- * Imports a JWK to a runtime-specific key representation (KeyLike). Either
- * JWK "alg" (Algorithm) Parameter must be present or the optional "alg" argument. When
- * running on a runtime using [Web Cryptography API](https://www.w3.org/TR/WebCryptoAPI/)
- * the jwk parameters "use", "key_ops", and "ext" are also used in the resulting `CryptoKey`.
- * See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210) to learn about key to algorithm
+ * Imports a JWK to a runtime-specific key representation (KeyLike). Either JWK "alg" (Algorithm)
+ * Parameter must be present or the optional "alg" argument. When running on a runtime using [Web
+ * Cryptography API](https://www.w3.org/TR/WebCryptoAPI/) the jwk parameters "use", "key_ops", and
+ * "ext" are also used in the resulting `CryptoKey`. See [Algorithm Key
+ * Requirements](https://github.com/panva/jose/issues/210) to learn about key to algorithm
  * requirements and mapping.
  *
- * @param jwk JSON Web Key.
- * @param alg JSON Web Algorithm identifier to be used with the imported key.
- * Default is the "alg" property on the JWK.
- * @param octAsKeyObject Forces a symmetric key to be imported to a KeyObject or
- * CryptoKey. Default is true unless JWK "ext" (Extractable) is true.
- *
  * @example Usage
+ *
  * ```js
- * const ecPublicKey = await jose.importJWK({
- *   crv: 'P-256',
- *   kty: 'EC',
- *   x: 'ySK38C1jBdLwDsNWKzzBHqKYEE5Cgv-qjWvorUXk9fw',
- *   y: '_LeQBw07cf5t57Iavn4j-BqJsAD1dpoz8gokd3sBsOo'
- * }, 'ES256')
+ * const ecPublicKey = await jose.importJWK(
+ *   {
+ *     crv: 'P-256',
+ *     kty: 'EC',
+ *     x: 'ySK38C1jBdLwDsNWKzzBHqKYEE5Cgv-qjWvorUXk9fw',
+ *     y: '_LeQBw07cf5t57Iavn4j-BqJsAD1dpoz8gokd3sBsOo',
+ *   },
+ *   'ES256',
+ * )
  *
- * const rsaPublicKey = await jose.importJWK({
- *   kty: 'RSA',
- *   e: 'AQAB',
- *   n: '12oBZRhCiZFJLcPg59LkZZ9mdhSMTKAQZYq32k_ti5SBB6jerkh-WzOMAO664r_qyLkqHUSp3u5SbXtseZEpN3XPWGKSxjsy-1JyEFTdLSYe6f9gfrmxkUF_7DTpq0gn6rntP05g2-wFW50YO7mosfdslfrTJYWHFhJALabAeYirYD7-9kqq9ebfFMF4sRRELbv9oi36As6Q9B3Qb5_C1rAzqfao_PCsf9EPsTZsVVVkA5qoIAr47lo1ipfiBPxUCCNSdvkmDTYgvvRm6ZoMjFbvOtgyts55fXKdMWv7I9HMD5HwE9uW839PWA514qhbcIsXEYSFMPMV6fnlsiZvQQ'
- * }, 'PS256')
+ * const rsaPublicKey = await jose.importJWK(
+ *   {
+ *     kty: 'RSA',
+ *     e: 'AQAB',
+ *     n: '12oBZRhCiZFJLcPg59LkZZ9mdhSMTKAQZYq32k_ti5SBB6jerkh-WzOMAO664r_qyLkqHUSp3u5SbXtseZEpN3XPWGKSxjsy-1JyEFTdLSYe6f9gfrmxkUF_7DTpq0gn6rntP05g2-wFW50YO7mosfdslfrTJYWHFhJALabAeYirYD7-9kqq9ebfFMF4sRRELbv9oi36As6Q9B3Qb5_C1rAzqfao_PCsf9EPsTZsVVVkA5qoIAr47lo1ipfiBPxUCCNSdvkmDTYgvvRm6ZoMjFbvOtgyts55fXKdMWv7I9HMD5HwE9uW839PWA514qhbcIsXEYSFMPMV6fnlsiZvQQ',
+ *   },
+ *   'PS256',
+ * )
  * ```
+ *
+ * @param jwk JSON Web Key.
+ * @param alg JSON Web Algorithm identifier to be used with the imported key. Default is the "alg"
+ *   property on the JWK.
+ * @param octAsKeyObject Forces a symmetric key to be imported to a KeyObject or CryptoKey. Default
+ *   is true unless JWK "ext" (Extractable) is true.
  */
 export declare function importJWK(jwk: JWK, alg?: string, octAsKeyObject?: boolean): Promise<KeyLike | Uint8Array>;