jose 5.9.1 → 5.9.3

package/dist/browser/jwks/remote.js

@@ -10,7 +10,7 @@ function isCloudflareWorkers() {
 let USER_AGENT;
 if (typeof navigator === 'undefined' || !navigator.userAgent?.startsWith?.('Mozilla/5.0 ')) {
     const NAME = 'jose';
-    const VERSION = 'v5.9.1';
+    const VERSION = 'v5.9.3';
     USER_AGENT = `${NAME}/${VERSION}`;
 }
 export const jwksCache = Symbol();

package/dist/browser/lib/jwt_claims_set.js

@@ -44,7 +44,8 @@ export default (protectedHeader, encodedPayload, options = {}) => {
             throw new JWTClaimValidationFailed(`missing required "${claim}" claim`, payload, claim, 'missing');
         }
     }
-    if (issuer && !(Array.isArray(issuer) ? issuer : [issuer]).includes(payload.iss)) {
+    if (issuer &&
+        !(Array.isArray(issuer) ? issuer : [issuer]).includes(payload.iss)) {
         throw new JWTClaimValidationFailed('unexpected "iss" claim value', payload, 'iss', 'check_failed');
     }
     if (subject && payload.sub !== subject) {

package/dist/browser/runtime/ecdhes.js

@@ -22,7 +22,8 @@ export async function deriveKey(publicKey, privateKey, algorithm, keyLength, apu
     }
     else {
         length =
-            Math.ceil(parseInt(publicKey.algorithm.namedCurve.substr(-3), 10) / 8) << 3;
+            Math.ceil(parseInt(publicKey.algorithm.namedCurve.substr(-3), 10) / 8) <<
+                3;
     }
     const sharedSecret = new Uint8Array(await crypto.subtle.deriveBits({
         name: publicKey.algorithm.name,

package/dist/browser/runtime/generate.js

@@ -135,5 +135,5 @@ export async function generateKeyPair(alg, options) {
         default:
             throw new JOSENotSupported('Invalid or unsupported JWK "alg" (Algorithm) Parameter value');
     }
-    return (crypto.subtle.generateKey(algorithm, options?.extractable ?? false, keyUsages));
+    return crypto.subtle.generateKey(algorithm, options?.extractable ?? false, keyUsages);
 }

package/dist/node/cjs/jwks/remote.js

@@ -13,7 +13,7 @@ function isCloudflareWorkers() {
 let USER_AGENT;
 if (typeof navigator === 'undefined' || !navigator.userAgent?.startsWith?.('Mozilla/5.0 ')) {
     const NAME = 'jose';
-    const VERSION = 'v5.9.1';
+    const VERSION = 'v5.9.3';
     USER_AGENT = `${NAME}/${VERSION}`;
 }
 exports.jwksCache = Symbol();

package/dist/node/cjs/lib/jwt_claims_set.js

@@ -46,7 +46,8 @@ exports.default = (protectedHeader, encodedPayload, options = {}) => {
             throw new errors_js_1.JWTClaimValidationFailed(`missing required "${claim}" claim`, payload, claim, 'missing');
         }
     }
-    if (issuer && !(Array.isArray(issuer) ? issuer : [issuer]).includes(payload.iss)) {
+    if (issuer &&
+        !(Array.isArray(issuer) ? issuer : [issuer]).includes(payload.iss)) {
         throw new errors_js_1.JWTClaimValidationFailed('unexpected "iss" claim value', payload, 'iss', 'check_failed');
     }
     if (subject && payload.sub !== subject) {

package/dist/node/cjs/runtime/jwk_to_key.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const node_crypto_1 = require("node:crypto");
-const parse = (jwk) => {
-    return (jwk.d ? node_crypto_1.createPrivateKey : node_crypto_1.createPublicKey)({ format: 'jwk', key: jwk });
+const parse = (key) => {
+    if (key.d) {
+        return (0, node_crypto_1.createPrivateKey)({ format: 'jwk', key });
+    }
+    return (0, node_crypto_1.createPublicKey)({ format: 'jwk', key });
 };
 exports.default = parse;

package/dist/node/esm/jwks/remote.js

@@ -10,7 +10,7 @@ function isCloudflareWorkers() {
 let USER_AGENT;
 if (typeof navigator === 'undefined' || !navigator.userAgent?.startsWith?.('Mozilla/5.0 ')) {
     const NAME = 'jose';
-    const VERSION = 'v5.9.1';
+    const VERSION = 'v5.9.3';
     USER_AGENT = `${NAME}/${VERSION}`;
 }
 export const jwksCache = Symbol();

package/dist/node/esm/lib/jwt_claims_set.js

@@ -44,7 +44,8 @@ export default (protectedHeader, encodedPayload, options = {}) => {
             throw new JWTClaimValidationFailed(`missing required "${claim}" claim`, payload, claim, 'missing');
         }
     }
-    if (issuer && !(Array.isArray(issuer) ? issuer : [issuer]).includes(payload.iss)) {
+    if (issuer &&
+        !(Array.isArray(issuer) ? issuer : [issuer]).includes(payload.iss)) {
         throw new JWTClaimValidationFailed('unexpected "iss" claim value', payload, 'iss', 'check_failed');
     }
     if (subject && payload.sub !== subject) {

package/dist/node/esm/runtime/jwk_to_key.js

@@ -1,5 +1,8 @@
 import { createPrivateKey, createPublicKey } from 'node:crypto';
-const parse = (jwk) => {
-    return (jwk.d ? createPrivateKey : createPublicKey)({ format: 'jwk', key: jwk });
+const parse = (key) => {
+    if (key.d) {
+        return createPrivateKey({ format: 'jwk', key });
+    }
+    return createPublicKey({ format: 'jwk', key });
 };
 export default parse;

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

@@ -3,7 +3,7 @@ import type { JWK, CompactVerifyResult, FlattenedJWSInput, GenericGetKeyFunction
  * 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) to verify using a remote JSON Web Key Set.
+ * @see {@link jwks/remote.createRemoteJWKSet createRemoteJWKSet} to verify using a remote JSON Web Key Set.
  */
 export interface CompactVerifyGetKey extends GenericGetKeyFunction<CompactJWSHeaderParameters, FlattenedJWSInput, KeyLike | JWK | Uint8Array> {
 }

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

@@ -3,7 +3,7 @@ import type { JWK, FlattenedVerifyResult, KeyLike, FlattenedJWSInput, JWSHeaderP
  * 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) to verify using a remote JSON Web Key Set.
+ * @see {@link jwks/remote.createRemoteJWKSet createRemoteJWKSet} to verify using a remote JSON Web Key Set.
  */
 export interface FlattenedVerifyGetKey extends GenericGetKeyFunction<JWSHeaderParameters | undefined, FlattenedJWSInput, KeyLike | JWK | Uint8Array> {
 }

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

@@ -3,7 +3,7 @@ import type { JWK, GeneralJWSInput, GeneralVerifyResult, FlattenedJWSInput, Gene
  * 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) to verify using a remote JSON Web Key Set.
+ * @see {@link jwks/remote.createRemoteJWKSet createRemoteJWKSet} to verify using a remote JSON Web Key Set.
  */
 export interface GeneralVerifyGetKey extends GenericGetKeyFunction<JWSHeaderParameters, FlattenedJWSInput, KeyLike | JWK | Uint8Array> {
 }

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

@@ -6,7 +6,7 @@ export interface JWTVerifyOptions extends VerifyOptions, JWTClaimVerificationOpt
  * 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) to verify using a remote JSON Web Key Set.
+ * @see {@link jwks/remote.createRemoteJWKSet createRemoteJWKSet} to verify using a remote JSON Web Key Set.
  */
 export interface JWTVerifyGetKey extends GenericGetKeyFunction<JWTHeaderParameters, FlattenedJWSInput, KeyLike | JWK | Uint8Array> {
 }

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

@@ -1,7 +1,7 @@
 import type { JWK, KeyLike } from '../types';
 /**
- * Exports a runtime-specific public key representation (KeyObject or CryptoKey) to a PEM-encoded
- * SPKI string format.
+ * Exports a runtime-specific public key representation ({@link !KeyObject} or {@link !CryptoKey}) to
+ * a PEM-encoded SPKI string format.
  *
  * This function is exported (as a named export) from the main `'jose'` module entry point as well
  * as from its subpath export `'jose/key/export'`.
@@ -10,8 +10,8 @@ import type { JWK, KeyLike } from '../types';
  */
 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.
+ * Exports a runtime-specific private key representation ({@link !KeyObject} or {@link !CryptoKey}) to
+ * a PEM-encoded PKCS8 string format.
  *
  * This function is exported (as a named export) from the main `'jose'` module entry point as well
  * as from its subpath export `'jose/key/export'`.

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

@@ -18,8 +18,7 @@ export interface GenerateKeyPairOptions {
     modulusLength?: number;
     /**
      * (Only effective in Web Crypto API runtimes) The value to use as
-     * {@link https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/generateKey SubtleCrypto.generateKey()}
-     * `extractable` argument. Default is false.
+     * {@link !SubtleCrypto.generateKey} `extractable` argument. Default is false.
      *
      */
     extractable?: boolean;

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

@@ -2,8 +2,7 @@ import type { KeyLike } from '../types';
 export interface GenerateSecretOptions {
     /**
      * (Only effective in Web Crypto API runtimes) The value to use as
-     * {@link https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/generateKey SubtleCrypto.generateKey()}
-     * `extractable` argument. Default is false.
+     * {@link !SubtleCrypto.generateKey} `extractable` argument. Default is false.
      */
     extractable?: boolean;
 }

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

@@ -1,15 +1,14 @@
 import type { JWK, KeyLike } from '../types';
 export interface PEMImportOptions {
     /**
-     * (Only effective in Web Crypto API runtimes) The value to use as
-     * {@link https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey SubtleCrypto.importKey()}
+     * (Only effective in Web Crypto API runtimes) The value to use as {@link !SubtleCrypto.importKey}
      * `extractable` argument. Default is false.
      */
     extractable?: boolean;
 }
 /**
- * Imports a PEM-encoded SPKI string as a runtime-specific public key representation (KeyObject or
- * CryptoKey).
+ * Imports a PEM-encoded SPKI string as a runtime-specific public key representation
+ * ({@link !KeyObject} or {@link !CryptoKey}).
  *
  * Note: The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
  * {@link https://w3c.github.io/webcrypto/ Web Cryptography API}, use the OID rsaEncryption
@@ -26,7 +25,7 @@ export interface PEMImportOptions {
 export declare function importSPKI<KeyLikeType extends KeyLike = KeyLike>(spki: string, alg: string, options?: PEMImportOptions): Promise<KeyLikeType>;
 /**
  * Imports the SPKI from an X.509 string certificate as a runtime-specific public key representation
- * (KeyObject or CryptoKey).
+ * ({@link !KeyObject} or {@link !CryptoKey}).
  *
  * Note: The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
  * {@link https://w3c.github.io/webcrypto/ Web Cryptography API}, use the OID rsaEncryption
@@ -42,8 +41,8 @@ export declare function importSPKI<KeyLikeType extends KeyLike = KeyLike>(spki:
  */
 export declare function importX509<KeyLikeType extends KeyLike = KeyLike>(x509: string, alg: string, options?: PEMImportOptions): Promise<KeyLikeType>;
 /**
- * Imports a PEM-encoded PKCS#8 string as a runtime-specific private key representation (KeyObject
- * or CryptoKey).
+ * Imports a PEM-encoded PKCS#8 string as a runtime-specific private key representation
+ * ({@link !KeyObject} or {@link !CryptoKey}).
  *
  * Note: The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
  * {@link https://w3c.github.io/webcrypto/ Web Cryptography API}, use the OID rsaEncryption
@@ -63,7 +62,7 @@ export declare function importPKCS8<KeyLikeType extends KeyLike = KeyLike>(pkcs8
  * (Algorithm) Parameter, or the optional "alg" argument, must be present.
  *
  * Note: When the runtime is using {@link https://w3c.github.io/webcrypto/ Web Cryptography API} the
- * jwk parameters "use", "key_ops", and "ext" are also used in the resulting `CryptoKey`.
+ * jwk parameters "use", "key_ops", and "ext" are also used in the resulting {@link !CryptoKey}.
  *
  * This function is exported (as a named export) from the main `'jose'` module entry point as well
  * as from its subpath export `'jose/key/import'`.

package/dist/types/types.d.ts

@@ -1,138 +1,123 @@
 /**
  * KeyLike are runtime-specific classes representing asymmetric keys or symmetric secrets. These are
- * instances of {@link https://developer.mozilla.org/en-US/docs/Web/API/CryptoKey CryptoKey} and
- * additionally {@link https://nodejs.org/api/crypto.html#class-keyobject KeyObject} in Node.js
- * runtime.
- * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array Uint8Array}
- * instances are also accepted as symmetric secret representation only.
+ * instances of {@link !CryptoKey} and additionally {@link !KeyObject} in Node.js runtime.
+ * {@link !Uint8Array} instances are also accepted as symmetric secret representation only.
  *
- * [Key Import Functions](../modules/key_import.md) can be used to import PEM, or JWK formatted
- * asymmetric keys and certificates to these runtime-specific representations.
+ * {@link key/import Key Import Functions} can be used to import PEM, or JWK formatted asymmetric
+ * keys and certificates to these runtime-specific representations.
  *
- * In Node.js the {@link https://nodejs.org/api/buffer.html#buffer Buffer} class is a subclass of
- * Uint8Array and so Buffer can be provided for symmetric secrets as well.
+ * In Node.js the {@link !Buffer} class is a subclass of {@link !Uint8Array} and so {@link !Buffer} can
+ * be provided for symmetric secrets as well.
  *
- * {@link https://nodejs.org/api/crypto.html#class-keyobject KeyObject} is a representation of a
- * key/secret available in the Node.js runtime. In addition to the import functions of this library
- * you may use the runtime APIs
- * {@link https://nodejs.org/api/crypto.html#cryptocreatepublickeykey crypto.createPublicKey},
- * {@link https://nodejs.org/api/crypto.html#cryptocreateprivatekeykey crypto.createPrivateKey}, and
- * {@link https://nodejs.org/api/crypto.html#cryptocreatesecretkeykey-encoding crypto.createSecretKey}
- * to obtain a `KeyObject` from your existing key material.
+ * {@link !KeyObject} is a representation of a key/secret available in the Node.js runtime. In
+ * addition to the {@link key/import Key Import Functions} you may use the runtime APIs
+ * {@link !createPublicKey}, {@link !createPrivateKey}, and {@link !createSecretKey} to obtain a
+ * {@link !KeyObject} from your existing key material.
  *
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/CryptoKey CryptoKey} is a representation
- * of a key/secret available in the Browser and Web-interoperable runtimes. In addition to the
- * import functions of this library you may use the
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey SubtleCrypto.importKey}
- * API to obtain a CryptoKey from your existing key material.
+ * {@link !CryptoKey} is a representation of a key/secret available in the Browser and
+ * Web-interoperable runtimes. In addition to the {@link key/import Key Import Functions} you may use
+ * the {@link !SubtleCrypto.importKey} API to obtain a {@link !CryptoKey} from your existing key
+ * material.
  *
  */
 export type KeyLike = { type: string }
 
 /** Generic JSON Web Key Parameters. */
 export interface JWKParameters {
-  /** JWK "kty" (Key Type) Parameter. */
+  /** JWK "kty" (Key Type) Parameter */
   kty: string
-  /** JWK "alg" (Algorithm) Parameter. */
+  /**
+   * JWK "alg" (Algorithm) Parameter
+   *
+   * @see {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}
+   */
   alg?: string
-  /** JWK "key_ops" (Key Operations) Parameter. */
+  /** JWK "key_ops" (Key Operations) Parameter */
   key_ops?: string[]
-  /** JWK "ext" (Extractable) Parameter. */
+  /** JWK "ext" (Extractable) Parameter */
   ext?: boolean
-  /** JWK "use" (Public Key Use) Parameter. */
+  /** JWK "use" (Public Key Use) Parameter */
   use?: string
-  /** JWK "x5c" (X.509 Certificate Chain) Parameter. */
+  /** JWK "x5c" (X.509 Certificate Chain) Parameter */
   x5c?: string[]
-  /** JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter. */
+  /** JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter */
   x5t?: string
-  /** "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter. */
+  /** JWK "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter */
   'x5t#S256'?: string
-  /** JWK "x5u" (X.509 URL) Parameter. */
+  /** JWK "x5u" (X.509 URL) Parameter */
   x5u?: string
-  /** JWK "kid" (Key ID) Parameter. */
+  /** JWK "kid" (Key ID) Parameter */
   kid?: string
-
-  [propName: string]: unknown
 }
 
 /** Convenience interface for Public OKP JSON Web Keys */
 export interface JWK_OKP_Public extends JWKParameters {
-  /** The Subtype of Key Pair */
+  /** OKP JWK "crv" (The Subtype of Key Pair) Parameter */
   crv: string
-  /** The public key */
+  /** OKP JWK "x" (The public key) Parameter */
   x: string
-
-  [propName: string]: unknown
 }
 
 /** Convenience interface for Private OKP JSON Web Keys */
 export interface JWK_OKP_Private extends JWK_OKP_Public, JWKParameters {
-  /** The Private Key */
+  /** OKP JWK "d" (The Private Key) Parameter */
   d: string
-
-  [propName: string]: unknown
 }
 
 /** Convenience interface for Public EC JSON Web Keys */
 export interface JWK_EC_Public extends JWKParameters {
-  /** Curve */
+  /** EC JWK "crv" (Curve) Parameter */
   crv: string
-  /** X Coordinate */
+  /** EC JWK "x" (X Coordinate) Parameter */
   x: string
-  /** Y Coordinate */
+  /** EC JWK "y" (Y Coordinate) Parameter */
   y: string
-
-  [propName: string]: unknown
 }
 
 /** Convenience interface for Private EC JSON Web Keys */
 export interface JWK_EC_Private extends JWK_EC_Public, JWKParameters {
-  /** ECC Private Key */
+  /** EC JWK "d" (ECC Private Key) Parameter */
   d: string
-
-  [propName: string]: unknown
 }
 
 /** Convenience interface for Public RSA JSON Web Keys */
 export interface JWK_RSA_Public extends JWKParameters {
-  /** Exponent */
+  /** RSA JWK "e" (Exponent) Parameter */
   e: string
-  /** Modulus */
+  /** RSA JWK "n" (Modulus) Parameter */
   n: string
-
-  [propName: string]: unknown
 }
 
 /** Convenience interface for Private RSA JSON Web Keys */
 export interface JWK_RSA_Private extends JWK_RSA_Public, JWKParameters {
-  /** Private Exponent */
+  /** RSA JWK "d" (Private Exponent) Parameter */
   d: string
-  /** First Factor CRT Exponent */
+  /** RSA JWK "dp" (First Factor CRT Exponent) Parameter */
   dp: string
-  /** Second Factor CRT Exponent */
+  /** RSA JWK "dq" (Second Factor CRT Exponent) Parameter */
   dq: string
-  /** Other Primes Info. This parameter is not supported. */
+  /**
+   * RSA JWK "oth" (Other Primes Info) Parameter
+   *
+   * This parameter is not supported
+   */
   oth?: Array<{
     d?: string
     r?: string
     t?: string
   }>
-  /** First Prime Factor */
+  /** RSA JWK "p" (First Prime Factor) Parameter */
   p: string
-  /** Second Prime Factor */
+  /** RSA JWK "q" (Second Prime Factor) Parameter */
   q: string
-  /** First CRT Coefficient */
+  /** RSA JWK "qi" (First CRT Coefficient) Parameter */
   qi: string
-
-  [propName: string]: unknown
 }
 
 /** Convenience interface for oct JSON Web Keys */
 export interface JWK_oct extends JWKParameters {
-  /** Key Value */
+  /** Oct JWK "k" (Key Value) Parameter */
   k: string
-
-  [propName: string]: unknown
 }
 
 /**
@@ -149,47 +134,49 @@ export interface JWK_oct extends JWKParameters {
  */
 export interface JWK extends JWKParameters {
   /**
-   * - (EC) Curve
-   * - (OKP) The Subtype of Key Pair
+   * - EC JWK "crv" (Curve) Parameter
+   * - OKP JWK "crv" (The Subtype of Key Pair) Parameter
    */
   crv?: string
   /**
-   * - (Private RSA) Private Exponent
-   * - (Private EC) ECC Private Key
-   * - (Private OKP) The Private Key
+   * - Private RSA JWK "d" (Private Exponent) Parameter
+   * - Private EC JWK "d" (ECC Private Key) Parameter
+   * - Private OKP JWK "d" (The Private Key) Parameter
    */
   d?: string
-  /** (Private RSA) First Factor CRT Exponent */
+  /** Private RSA JWK "dp" (First Factor CRT Exponent) Parameter */
   dp?: string
-  /** (Private RSA) Second Factor CRT Exponent */
+  /** Private RSA JWK "dq" (Second Factor CRT Exponent) Parameter */
   dq?: string
-  /** (RSA) Exponent */
+  /** RSA JWK "e" (Exponent) Parameter */
   e?: string
-  /** (oct) Key Value */
+  /** Oct JWK "k" (Key Value) Parameter */
   k?: string
-  /** (RSA) Modulus */
+  /** RSA JWK "n" (Modulus) Parameter */
   n?: string
-  /** (Private RSA) Other Primes Info. This parameter is not supported. */
+  /**
+   * Private RSA JWK "oth" (Other Primes Info) Parameter
+   *
+   * This parameter is not supported
+   */
   oth?: Array<{
     d?: string
     r?: string
     t?: string
   }>
-  /** (Private RSA) First Prime Factor */
+  /** Private RSA JWK "p" (First Prime Factor) Parameter */
   p?: string
-  /** (Private RSA) Second Prime Factor */
+  /** Private RSA JWK "q" (Second Prime Factor) Parameter */
   q?: string
-  /** (Private RSA) First CRT Coefficient */
+  /** Private RSA JWK "qi" (First CRT Coefficient) Parameter */
   qi?: string
   /**
-   * - (EC) X Coordinate
-   * - (OKP) The public key
+   * - EC JWK "x" (X Coordinate) Parameter
+   * - OKP JWK "x" (The public key) Parameter
    */
   x?: string
-  /** (EC) Y Coordinate */
+  /** EC JWK "y" (Y Coordinate) Parameter */
   y?: string
-
-  [propName: string]: unknown
 }
 
 /**
@@ -220,8 +207,8 @@ export interface GetKeyFunction<IProtectedHeader, IToken>
   extends GenericGetKeyFunction<IProtectedHeader, IToken, KeyLike | Uint8Array> {}
 
 /**
- * Flattened JWS definition for verify function inputs, allows payload as Uint8Array for detached
- * signature validation.
+ * Flattened JWS definition for verify function inputs, allows payload as {@link !Uint8Array} for
+ * detached signature validation.
  */
 export interface FlattenedJWSInput {
   /**
@@ -234,7 +221,7 @@ export interface FlattenedJWSInput {
 
   /**
    * The "payload" member MUST be present and contain the value BASE64URL(JWS Payload). When RFC7797
-   * "b64": false is used the value passed may also be a Uint8Array.
+   * "b64": false is used the value passed may also be a {@link !Uint8Array}.
    */
   payload: string | Uint8Array
 
@@ -250,14 +237,14 @@ export interface FlattenedJWSInput {
 }
 
 /**
- * General JWS definition for verify function inputs, allows payload as Uint8Array for detached
- * signature validation.
+ * General JWS definition for verify function inputs, allows payload as {@link !Uint8Array} for
+ * detached signature validation.
  */
 export interface GeneralJWSInput {
   /**
    * The "payload" member MUST be present and contain the value BASE64URL(JWS Payload). When when
    * JWS Unencoded Payload ({@link https://www.rfc-editor.org/rfc/rfc7797 RFC7797}) "b64": false is
-   * used the value passed may also be a Uint8Array.
+   * used the value passed may also be a {@link !Uint8Array}.
    */
   payload: string | Uint8Array
 
@@ -287,34 +274,38 @@ export interface GeneralJWS {
 }
 
 export interface JoseHeaderParameters {
-  /** "kid" (Key ID) Header Parameter. */
+  /** "kid" (Key ID) Header Parameter */
   kid?: string
 
-  /** "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter. */
+  /** "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter */
   x5t?: string
 
-  /** "x5c" (X.509 Certificate Chain) Header Parameter. */
+  /** "x5c" (X.509 Certificate Chain) Header Parameter */
   x5c?: string[]
 
-  /** "x5u" (X.509 URL) Header Parameter. */
+  /** "x5u" (X.509 URL) Header Parameter */
   x5u?: string
 
-  /** "jku" (JWK Set URL) Header Parameter. */
+  /** "jku" (JWK Set URL) Header Parameter */
   jku?: string
 
-  /** "jwk" (JSON Web Key) Header Parameter. */
+  /** "jwk" (JSON Web Key) Header Parameter */
   jwk?: Pick<JWK, 'kty' | 'crv' | 'x' | 'y' | 'e' | 'n'>
 
-  /** "typ" (Type) Header Parameter. */
+  /** "typ" (Type) Header Parameter */
   typ?: string
 
-  /** "cty" (Content Type) Header Parameter. */
+  /** "cty" (Content Type) Header Parameter */
   cty?: string
 }
 
 /** Recognized JWS Header Parameters, any other Header Members may also be present. */
 export interface JWSHeaderParameters extends JoseHeaderParameters {
-  /** JWS "alg" (Algorithm) Header Parameter. */
+  /**
+   * JWS "alg" (Algorithm) Header Parameter
+   *
+   * @see {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}
+   */
   alg?: string
 
   /**
@@ -323,7 +314,7 @@ export interface JWSHeaderParameters extends JoseHeaderParameters {
    */
   b64?: boolean
 
-  /** JWS "crit" (Critical) Header Parameter. */
+  /** JWS "crit" (Critical) Header Parameter */
   crit?: string[]
 
   /** Any other JWS Header member. */
@@ -416,13 +407,21 @@ export interface GeneralJWE extends Omit<FlattenedJWE, 'encrypted_key' | 'header
 
 /** Recognized JWE Header Parameters, any other Header members may also be present. */
 export interface JWEHeaderParameters extends JoseHeaderParameters {
-  /** JWE "alg" (Algorithm) Header Parameter. */
+  /**
+   * JWE "alg" (Algorithm) Header Parameter
+   *
+   * @see {@link https://github.com/panva/jose/issues/210#jwe-alg Algorithm Key Requirements}
+   */
   alg?: string
 
-  /** JWE "enc" (Encryption Algorithm) Header Parameter. */
+  /**
+   * JWE "enc" (Encryption Algorithm) Header Parameter
+   *
+   * @see {@link https://github.com/panva/jose/issues/210#jwe-alg Algorithm Key Requirements}
+   */
   enc?: string
 
-  /** JWE "crit" (Critical) Header Parameter. */
+  /** JWE "crit" (Critical) Header Parameter */
   crit?: string[]
 
   /**

package/dist/types/util/base64url.d.ts

@@ -1,5 +1,5 @@
 /**
- * Utility function to encode a string or Uint8Array as a base64url string.
+ * Utility function to encode a string or {@link !Uint8Array} as a base64url string.
  *
  * @param input Value that will be base64url-encoded.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jose",
-  "version": "5.9.1",
+  "version": "5.9.3",
   "description": "JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other Web-interoperable runtimes",
   "keywords": [
     "browser",