@suveren/gateway 0.7.4 → 0.8.0

package/node_modules/jose/dist/types/jwe/general/encrypt.d.ts

@@ -1,39 +1,33 @@
-import type * as types from '../../types.d.ts';
-/** Used to build General JWE object's individual recipients. */
+import type * as t from '../../types.d.ts';
+/** Configures an individual recipient in a General JWE. */
 export interface Recipient {
+    /** Sets the JWE Per-Recipient Unprotected Header on the Recipient object. */
+    setUnprotectedHeader(unprotectedHeader: t.JWEHeaderParameters): Recipient;
     /**
-     * Sets the JWE Per-Recipient Unprotected Header on the Recipient object.
-     *
-     * @param unprotectedHeader JWE Per-Recipient Unprotected Header.
-     */
-    setUnprotectedHeader(unprotectedHeader: types.JWEHeaderParameters): Recipient;
-    /**
-     * Sets the JWE Key Management parameters to be used when encrypting. For ECDH based algorithms,
-     * use this method to set the "apu" (Agreement PartyUInfo) or "apv" (Agreement PartyVInfo)
-     * parameters.
-     *
-     * @param parameters JWE Key Management parameters.
+     * Sets the JWE Key Management parameters to be used when encrypting. Use this method instead of
+     * the header setters to configure algorithm inputs such as ECDH-ES "apu" (Agreement PartyUInfo)
+     * and "apv" (Agreement PartyVInfo), or PBES2 "p2c" (PBES2 Count). The parameters are added to the
+     * appropriate JOSE Header.
      */
-    setKeyManagementParameters(parameters: types.JWEKeyManagementHeaderParameters): Recipient;
+    setKeyManagementParameters(parameters: t.JWEKeyManagementHeaderParameters): Recipient;
     /**
      * A shorthand for calling {@link GeneralEncrypt.addRecipient addRecipient()} on the enclosing
      * {@link GeneralEncrypt} instance.
      *
      * @param key Public Key or Secret to encrypt the Content Encryption Key for the recipient with.
      *   See {@link https://github.com/panva/jose/issues/210#jwe-alg Algorithm Key Requirements}.
-     * @param options JWE Encryption options.
      */
-    addRecipient(key: types.KeyInput, options?: types.CritOption): Recipient;
+    addRecipient(key: t.KeyInput, options?: t.CritOption): Recipient;
     /**
      * A shorthand for calling {@link GeneralEncrypt.encrypt encrypt()} on the enclosing
      * {@link GeneralEncrypt} instance. Takes no arguments — each recipient's key is supplied to
      * {@link addRecipient}.
      */
-    encrypt(): Promise<types.GeneralJWE>;
+    encrypt(): Promise<t.GeneralJWE>;
     /** Returns the enclosing {@link GeneralEncrypt} instance */
     done(): GeneralEncrypt;
 }
-/** The GeneralEncrypt class is used to build and encrypt General JWE objects. */
+/** Builds and encrypts General JWE objects. */
 export declare class GeneralEncrypt {
     #private;
     /**
@@ -47,27 +41,14 @@ export declare class GeneralEncrypt {
      *
      * @param key Public Key or Secret to encrypt the Content Encryption Key for the recipient with.
      *   See {@link https://github.com/panva/jose/issues/210#jwe-alg Algorithm Key Requirements}.
-     * @param options JWE Encryption options.
-     */
-    addRecipient(key: types.KeyInput, options?: types.CritOption): Recipient;
-    /**
-     * Sets the JWE Protected Header on the GeneralEncrypt object.
-     *
-     * @param protectedHeader JWE Protected Header object.
-     */
-    setProtectedHeader(protectedHeader: types.JWEHeaderParameters): this;
-    /**
-     * Sets the JWE Shared Unprotected Header on the GeneralEncrypt object.
-     *
-     * @param sharedUnprotectedHeader JWE Shared Unprotected Header object.
-     */
-    setSharedUnprotectedHeader(sharedUnprotectedHeader: types.JWEHeaderParameters): this;
-    /**
-     * Sets the Additional Authenticated Data on the GeneralEncrypt object.
-     *
-     * @param aad Additional Authenticated Data.
      */
+    addRecipient(key: t.KeyInput, options?: t.CritOption): Recipient;
+    /** Sets the JWE Protected Header on the GeneralEncrypt object. */
+    setProtectedHeader(protectedHeader: t.JWEHeaderParameters): this;
+    /** Sets the JWE Shared Unprotected Header on the GeneralEncrypt object. */
+    setSharedUnprotectedHeader(sharedUnprotectedHeader: t.JWEHeaderParameters): this;
+    /** Sets the Additional Authenticated Data on the GeneralEncrypt object. */
     setAdditionalAuthenticatedData(aad: Uint8Array): this;
     /** Encrypts and resolves the value of the General JWE object. */
-    encrypt(): Promise<types.GeneralJWE>;
+    encrypt(): Promise<t.GeneralJWE>;
 }

package/node_modules/jose/dist/types/jwk/embedded.d.ts

@@ -1,13 +1,8 @@
-import type * as types from '../types.d.ts';
+import type * as t from '../types.d.ts';
 /**
- * EmbeddedJWK is an implementation of a {@link types.GetKeyFunction GetKeyFunction} intended to be
- * used with the JWS/JWT verify operations whenever you need to opt-in to verify signatures with a
- * public key embedded in the token's "jwk" (JSON Web Key) Header Parameter. It is recommended to
- * combine this with the verify function's `algorithms` option to define accepted JWS "alg"
- * (Algorithm) Header Parameter values.
+ * Resolves a verification key from an embedded "jwk" (JSON Web Key) Header Parameter.
  *
- * @param protectedHeader JWS Protected Header.
  * @param token The consumed JWS token.
  * @returns The public key from the JWS "jwk" (JSON Web Key) Header Parameter.
  */
-export declare function EmbeddedJWK(protectedHeader?: types.JWSHeaderParameters, token?: types.FlattenedJWSInput): Promise<types.CryptoKey>;
+export declare function EmbeddedJWK(protectedHeader?: t.JWSHeaderParameters, token?: t.FlattenedJWSInput): Promise<t.CryptoKey>;

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

@@ -1,17 +1,17 @@
-import type * as types from '../types.d.ts';
+import type * as t from '../types.d.ts';
 /**
- * Calculates a base64url-encoded JSON Web Key (JWK) Thumbprint
+ * Calculates a base64url-encoded JSON Web Key (JWK) Thumbprint.
  *
  * @param key Key to calculate the thumbprint for.
  * @param digestAlgorithm Digest Algorithm to use for calculating the thumbprint. Default is
  *   "sha256".
  */
-export declare function calculateJwkThumbprint(key: types.JWK | types.CryptoKey | types.KeyObject, digestAlgorithm?: 'sha256' | 'sha384' | 'sha512'): Promise<string>;
+export declare function calculateJwkThumbprint(key: t.JWK | t.CryptoKey | t.KeyObject, digestAlgorithm?: 'sha256' | 'sha384' | 'sha512'): Promise<string>;
 /**
- * Calculates a JSON Web Key (JWK) Thumbprint URI
+ * Calculates a JSON Web Key (JWK) Thumbprint URI.
  *
  * @param key Key to calculate the thumbprint for.
  * @param digestAlgorithm Digest Algorithm to use for calculating the thumbprint. Default is
  *   "sha256".
  */
-export declare function calculateJwkThumbprintUri(key: types.CryptoKey | types.KeyObject | types.JWK, digestAlgorithm?: 'sha256' | 'sha384' | 'sha512'): Promise<string>;
+export declare function calculateJwkThumbprintUri(key: t.CryptoKey | t.KeyObject | t.JWK, digestAlgorithm?: 'sha256' | 'sha384' | 'sha512'): Promise<string>;

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

@@ -1,20 +1,16 @@
-import type * as types from '../types.d.ts';
-/** The key resolution function returned by {@link createLocalJWKSet}. */
+import type * as t from '../types.d.ts';
+/** A key resolver created by {@link createLocalJWKSet}. */
 export interface LocalJWKSet {
-    (protectedHeader?: types.JWSHeaderParameters, token?: types.FlattenedJWSInput): Promise<types.CryptoKey>;
+    (protectedHeader?: t.JWSHeaderParameters, token?: t.FlattenedJWSInput): Promise<t.CryptoKey>;
     /** Returns a structured clone of the JSON Web Key Set this resolver was created with. */
-    jwks: () => types.JSONWebKeySet;
+    jwks: () => t.JSONWebKeySet;
 }
 /**
- * Returns a function that resolves a JWS JOSE Header to a public key object from a locally stored,
- * or otherwise available, JSON Web Key Set. Selection respects the header's "alg" (Algorithm) and
- * "kid" (Key ID) as well as the JWK's "use" (Public Key Use) and "key_ops" (Key Operations).
- * Exactly one key must match; if multiple keys match, the thrown `JWKSMultipleMatchingKeys` can be
- * iterated.
+ * Creates a resolver for a locally available JSON Web Key Set.
  *
  * > Note: The function's purpose is to resolve public keys used for verifying signatures and will not work
  * > for public encryption keys.
  *
  * @param jwks JSON Web Key Set formatted object.
  */
-export declare function createLocalJWKSet(jwks: types.JSONWebKeySet): LocalJWKSet;
+export declare function createLocalJWKSet(jwks: t.JSONWebKeySet): LocalJWKSet;

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

@@ -1,13 +1,12 @@
-import type * as types from '../types.d.ts';
+import type * as t from '../types.d.ts';
 /**
- * When passed to {@link jwks/remote.createRemoteJWKSet createRemoteJWKSet} this allows the resolver
- * to make use of advanced fetch configurations, HTTP Proxies, retry on network errors, etc.
+ * Symbol used to configure a custom fetch implementation for remote JWKS retrieval.
  *
  * > Note: Known caveat: Expect Type-related issues when passing the inputs through to fetch-like modules,
  * > they hardly ever get their typings inline with actual fetch, you should `@ts-expect-error` them.
  */
 export declare const customFetch: unique symbol;
-/** See {@link customFetch}. */
+/** Function signature accepted by {@link customFetch}. */
 export type FetchImplementation = (
 /** URL the request is being made sent to {@link !fetch} as the `resource` argument */
 url: string, 
@@ -22,31 +21,28 @@ options: {
     signal: AbortSignal;
 }) => Promise<Response>;
 /**
+ * Symbol used to configure an externally persisted remote JWKS cache.
+ *
  * > Warning: This option has security implications that must be understood, assessed for applicability, and
  * > accepted before use. It is critical that the JSON Web Key Set cache only be writable by your own
  * > code.
- *
- * This option is intended for cloud computing runtimes that cannot keep an in memory cache between
- * their code's invocations. The supplied writable object seeds the resolver's cache and is updated
- * with `jwks` and `uat` after a successful fetch; persist it whenever `uat` changes. Using this in
- * runtimes that can keep an in-memory cache between requests is not desirable.
  */
 export declare const jwksCache: unique symbol;
-/** Options for the remote JSON Web Key Set. */
+/** Remote JWKS resolver options. */
 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).
+     * the verification will fail. Must be a non-negative integer. 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).
+     * successful fetch. Must not be `NaN`. Default is 30000 (30 seconds).
      */
     cooldownDuration?: number;
     /**
      * Maximum time (in milliseconds) between successful HTTP requests. Default is 600000 (10
-     * minutes).
+     * minutes). Must not be `NaN`.
      */
     cacheMaxAge?: number | typeof Infinity;
     /** Headers to be sent with the HTTP request. */
@@ -56,18 +52,18 @@ export interface RemoteJWKSetOptions {
     /** See {@link customFetch}. */
     [customFetch]?: FetchImplementation;
 }
-/** See {@link jwksCache}. */
+/** Shape of an externally persisted remote JWKS cache. */
 export interface ExportedJWKSCache {
     /** Current cached JSON Web Key Set */
-    jwks: types.JSONWebKeySet;
-    /** Last updated at timestamp (seconds since epoch) */
+    jwks: t.JSONWebKeySet;
+    /** Last updated at timestamp (milliseconds since epoch) */
     uat: number;
 }
-/** See {@link jwksCache}. */
+/** Values accepted by the {@link jwksCache} option. */
 export type JWKSCacheInput = ExportedJWKSCache | Record<string, never>;
-/** The key resolution function returned by {@link createRemoteJWKSet}. */
+/** A key resolver created by {@link createRemoteJWKSet}. */
 export interface RemoteJWKSet {
-    (protectedHeader?: types.JWSHeaderParameters, token?: types.FlattenedJWSInput): Promise<types.CryptoKey>;
+    (protectedHeader?: t.JWSHeaderParameters, token?: t.FlattenedJWSInput): Promise<t.CryptoKey>;
     /** Whether the cooldown window following the last successful fetch is still in effect. */
     readonly coolingDown: boolean;
     /**
@@ -86,21 +82,14 @@ export interface RemoteJWKSet {
      * The currently cached JSON Web Key Set, or `undefined` when none has been fetched or seeded via
      * {@link jwksCache} yet.
      */
-    jwks: () => types.JSONWebKeySet | undefined;
+    jwks: () => t.JSONWebKeySet | undefined;
 }
 /**
- * Returns a function that resolves a JWS JOSE Header to a public 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. 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. Selection respects the
- * header's "alg" (Algorithm) and "kid" (Key ID) as well as the JWK's "use" (Public Key Use) and
- * "key_ops" (Key Operations). Exactly one key must match; if multiple keys match, the thrown
- * `JWKSMultipleMatchingKeys` can be iterated.
+ * Creates a resolver for a JSON Web Key Set available at an HTTP(S) URL.
  *
  * > Note: The function's purpose is to resolve public keys used for verifying signatures and will not work
  * > for public encryption keys.
  *
  * @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): RemoteJWKSet;

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

@@ -1,5 +1,5 @@
-import type * as types from '../../types.d.ts';
-/** The CompactSign class is used to build and sign Compact JWS strings. */
+import type * as t from '../../types.d.ts';
+/** Builds and signs Compact JWS strings. */
 export declare class CompactSign {
     #private;
     /**
@@ -8,18 +8,13 @@ export declare class CompactSign {
      * @param payload Binary representation of the payload to sign.
      */
     constructor(payload: Uint8Array);
-    /**
-     * Sets the JWS Protected Header on the CompactSign object.
-     *
-     * @param protectedHeader JWS Protected Header.
-     */
-    setProtectedHeader(protectedHeader: types.CompactJWSHeaderParameters): this;
+    /** Sets the JWS Protected Header on the CompactSign object. */
+    setProtectedHeader(protectedHeader: t.CompactJWSHeaderParameters): this;
     /**
      * Signs and resolves the value of the Compact JWS string.
      *
      * @param key Private Key or Secret to sign the JWS with. See
      *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
-     * @param options JWS Sign options.
      */
-    sign(key: types.KeyInput, options?: types.SignOptions): Promise<string>;
+    sign(key: t.KeyInput, options?: t.SignOptions): Promise<string>;
 }

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

@@ -1,37 +1,28 @@
-import type * as types from '../../types.d.ts';
-/**
- * Interface for Compact JWS Verification dynamic key resolution. No token components have been
- * verified at the time of this function call.
- */
-export interface CompactVerifyGetKey<KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array> extends types.GetKeyFunction<types.CompactJWSHeaderParameters, types.FlattenedJWSInput, KeyType | types.KeyObject | types.JWK> {
+import type * as t from '../../types.d.ts';
+/** Dynamic key resolver for Compact JWS verification. */
+export interface CompactVerifyGetKey<KeyType extends t.CryptoKey | Uint8Array = t.CryptoKey | Uint8Array> extends t.GetKeyFunction<t.CompactJWSHeaderParameters, t.FlattenedJWSInput, KeyType | t.KeyObject | t.JWK> {
 }
 /**
- * Verifies the signature and format of and afterwards decodes the Compact JWS.
+ * Verifies a Compact JWS signature and decodes its payload.
  *
- * @param jws Compact JWS.
  * @param key Key to verify the JWS with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWS Verify options.
  */
-export declare function compactVerify(jws: string | Uint8Array, key: types.KeyInput, options?: types.VerifyOptions): Promise<types.CompactVerifyResult>;
+export declare function compactVerify(jws: string | Uint8Array, key: t.KeyInput, options?: t.VerifyOptions): Promise<t.CompactVerifyResult>;
 /**
- * Verifies the signature and format of and afterwards decodes the Compact JWS, resolving the key
- * dynamically. The result additionally carries the {@link types.ResolvedKey.key resolved key}.
+ * Verifies a Compact JWS signature and decodes its payload, resolving the key dynamically. The
+ * result additionally carries the {@link t.ResolvedKey.key resolved key}.
  *
- * @param jws Compact JWS.
  * @param getKey Function resolving a key to verify the JWS with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWS Verify options.
  */
-export declare function compactVerify<KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array>(jws: string | Uint8Array, getKey: CompactVerifyGetKey<KeyType>, options?: types.VerifyOptions): Promise<types.CompactVerifyResult & types.ResolvedKey<KeyType>>;
+export declare function compactVerify<KeyType extends t.CryptoKey | Uint8Array = t.CryptoKey | Uint8Array>(jws: string | Uint8Array, getKey: CompactVerifyGetKey<KeyType>, options?: t.VerifyOptions): Promise<t.CompactVerifyResult & t.ResolvedKey<KeyType>>;
 /**
  * Accepts either form of the `key` argument. Use this overload when forwarding a value that may be
  * either a key or a key resolution function; `key` is present on the result only when a resolution
  * function was used.
  *
- * @param jws Compact JWS.
  * @param key Key, or function resolving a key, to verify the JWS with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWS Verify options.
  */
-export declare function compactVerify(jws: string | Uint8Array, key: types.KeyInput | CompactVerifyGetKey, options?: types.VerifyOptions): Promise<types.CompactVerifyResult & Partial<types.ResolvedKey>>;
+export declare function compactVerify(jws: string | Uint8Array, key: t.KeyInput | CompactVerifyGetKey, options?: t.VerifyOptions): Promise<t.CompactVerifyResult & Partial<t.ResolvedKey>>;

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

@@ -1,5 +1,5 @@
-import type * as types from '../../types.d.ts';
-/** The FlattenedSign class is used to build and sign Flattened JWS objects. */
+import type * as t from '../../types.d.ts';
+/** Builds and signs Flattened JWS objects. */
 export declare class FlattenedSign {
     #private;
     /**
@@ -8,24 +8,15 @@ export declare class FlattenedSign {
      * @param payload Binary representation of the payload to sign.
      */
     constructor(payload: Uint8Array);
-    /**
-     * Sets the JWS Protected Header on the FlattenedSign object.
-     *
-     * @param protectedHeader JWS Protected Header.
-     */
-    setProtectedHeader(protectedHeader: types.JWSHeaderParameters): this;
-    /**
-     * Sets the JWS Unprotected Header on the FlattenedSign object.
-     *
-     * @param unprotectedHeader JWS Unprotected Header.
-     */
-    setUnprotectedHeader(unprotectedHeader: types.JWSHeaderParameters): this;
+    /** Sets the JWS Protected Header on the FlattenedSign object. */
+    setProtectedHeader(protectedHeader: t.JWSHeaderParameters): this;
+    /** Sets the JWS Unprotected Header on the FlattenedSign object. */
+    setUnprotectedHeader(unprotectedHeader: t.JWSHeaderParameters): this;
     /**
      * Signs and resolves the value of the Flattened JWS object.
      *
      * @param key Private Key or Secret to sign the JWS with. See
      *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
-     * @param options JWS Sign options.
      */
-    sign(key: types.KeyInput, options?: types.SignOptions): Promise<types.FlattenedJWS>;
+    sign(key: t.KeyInput, options?: t.SignOptions): Promise<t.FlattenedJWS>;
 }

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

@@ -1,37 +1,28 @@
-import type * as types from '../../types.d.ts';
-/**
- * Interface for Flattened JWS Verification dynamic key resolution. No token components have been
- * verified at the time of this function call.
- */
-export interface FlattenedVerifyGetKey<KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array> extends types.GetKeyFunction<types.JWSHeaderParameters, types.FlattenedJWSInput, KeyType | types.KeyObject | types.JWK> {
+import type * as t from '../../types.d.ts';
+/** Dynamic key resolver for Flattened JWS verification. */
+export interface FlattenedVerifyGetKey<KeyType extends t.CryptoKey | Uint8Array = t.CryptoKey | Uint8Array> extends t.GetKeyFunction<t.JWSHeaderParameters, t.FlattenedJWSInput, KeyType | t.KeyObject | t.JWK> {
 }
 /**
- * Verifies the signature and format of and afterwards decodes the Flattened JWS.
+ * Verifies a Flattened JWS signature and decodes its payload.
  *
- * @param jws Flattened JWS.
  * @param key Key to verify the JWS with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWS Verify options.
  */
-export declare function flattenedVerify(jws: types.FlattenedJWSInput, key: types.KeyInput, options?: types.VerifyOptions): Promise<types.FlattenedVerifyResult>;
+export declare function flattenedVerify(jws: t.FlattenedJWSInput, key: t.KeyInput, options?: t.VerifyOptions): Promise<t.FlattenedVerifyResult>;
 /**
- * Verifies the signature and format of and afterwards decodes the Flattened JWS, resolving the key
- * dynamically. The result additionally carries the {@link types.ResolvedKey.key resolved key}.
+ * Verifies a Flattened JWS signature and decodes its payload, resolving the key dynamically. The
+ * result additionally carries the {@link t.ResolvedKey.key resolved key}.
  *
- * @param jws Flattened JWS.
  * @param getKey Function resolving a key to verify the JWS with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWS Verify options.
  */
-export declare function flattenedVerify<KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array>(jws: types.FlattenedJWSInput, getKey: FlattenedVerifyGetKey<KeyType>, options?: types.VerifyOptions): Promise<types.FlattenedVerifyResult & types.ResolvedKey<KeyType>>;
+export declare function flattenedVerify<KeyType extends t.CryptoKey | Uint8Array = t.CryptoKey | Uint8Array>(jws: t.FlattenedJWSInput, getKey: FlattenedVerifyGetKey<KeyType>, options?: t.VerifyOptions): Promise<t.FlattenedVerifyResult & t.ResolvedKey<KeyType>>;
 /**
  * Accepts either form of the `key` argument. Use this overload when forwarding a value that may be
  * either a key or a key resolution function; `key` is present on the result only when a resolution
  * function was used.
  *
- * @param jws Flattened JWS.
  * @param key Key, or function resolving a key, to verify the JWS with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWS Verify options.
  */
-export declare function flattenedVerify(jws: types.FlattenedJWSInput, key: types.KeyInput | FlattenedVerifyGetKey, options?: types.VerifyOptions): Promise<types.FlattenedVerifyResult & Partial<types.ResolvedKey>>;
+export declare function flattenedVerify(jws: t.FlattenedJWSInput, key: t.KeyInput | FlattenedVerifyGetKey, options?: t.VerifyOptions): Promise<t.FlattenedVerifyResult & Partial<t.ResolvedKey>>;

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

@@ -1,36 +1,27 @@
-import type * as types from '../../types.d.ts';
-/** Used to build General JWS object's individual signatures. */
+import type * as t from '../../types.d.ts';
+/** Configures an individual signature in a General JWS. */
 export interface Signature {
-    /**
-     * Sets the JWS Protected Header on the Signature object.
-     *
-     * @param protectedHeader JWS Protected Header.
-     */
-    setProtectedHeader(protectedHeader: types.JWSHeaderParameters): Signature;
-    /**
-     * Sets the JWS Unprotected Header on the Signature object.
-     *
-     * @param unprotectedHeader JWS Unprotected Header.
-     */
-    setUnprotectedHeader(unprotectedHeader: types.JWSHeaderParameters): Signature;
+    /** Sets the JWS Protected Header on the Signature object. */
+    setProtectedHeader(protectedHeader: t.JWSHeaderParameters): Signature;
+    /** Sets the JWS Unprotected Header on the Signature object. */
+    setUnprotectedHeader(unprotectedHeader: t.JWSHeaderParameters): Signature;
     /**
      * A shorthand for calling {@link GeneralSign.addSignature addSignature()} on the enclosing
      * {@link GeneralSign} instance.
      *
      * @param key Private Key or Secret to sign the individual JWS signature with. See
      *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
-     * @param options JWS Sign options.
      */
-    addSignature(key: types.KeyInput, options?: types.SignOptions): Signature;
+    addSignature(key: t.KeyInput, options?: t.SignOptions): Signature;
     /**
      * A shorthand for calling {@link GeneralSign.sign sign()} on the enclosing {@link GeneralSign}
      * instance. Takes no arguments — each signature's key is supplied to {@link addSignature}.
      */
-    sign(): Promise<types.GeneralJWS>;
+    sign(): Promise<t.GeneralJWS>;
     /** Returns the enclosing {@link GeneralSign} instance */
     done(): GeneralSign;
 }
-/** The GeneralSign class is used to build and sign General JWS objects. */
+/** Builds and signs General JWS objects. */
 export declare class GeneralSign {
     #private;
     /**
@@ -44,9 +35,8 @@ export declare class GeneralSign {
      *
      * @param key Private Key or Secret to sign the individual JWS signature with. See
      *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
-     * @param options JWS Sign options.
      */
-    addSignature(key: types.KeyInput, options?: types.SignOptions): Signature;
+    addSignature(key: t.KeyInput, options?: t.SignOptions): Signature;
     /** Signs and resolves the value of the General JWS object. */
-    sign(): Promise<types.GeneralJWS>;
+    sign(): Promise<t.GeneralJWS>;
 }

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

@@ -1,44 +1,35 @@
-import type * as types from '../../types.d.ts';
-/**
- * Interface for General JWS Verification dynamic key resolution. No token components have been
- * verified at the time of this function call.
- */
-export interface GeneralVerifyGetKey<KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array> extends types.GetKeyFunction<types.JWSHeaderParameters, types.FlattenedJWSInput, KeyType | types.KeyObject | types.JWK> {
+import type * as t from '../../types.d.ts';
+/** Dynamic key resolver for General JWS verification. */
+export interface GeneralVerifyGetKey<KeyType extends t.CryptoKey | Uint8Array = t.CryptoKey | Uint8Array> extends t.GetKeyFunction<t.JWSHeaderParameters, t.FlattenedJWSInput, KeyType | t.KeyObject | t.JWK> {
 }
 /**
- * Verifies the signature and format of and afterwards decodes the General JWS.
+ * Verifies a General JWS signature and decodes its payload.
  *
  * > Note: The function iterates over the `signatures` array in the General JWS and returns the verification
  * > result of the first signature entry that can be successfully verified. The result only contains
  * > the payload, protected header, and unprotected header of that successfully verified signature
- * > entry. Other signature entries in the General JWS are not validated, and their headers are not
- * > included in the returned result. Recipients of a General JWS should only rely on the returned
- * > (verified) data.
+ * > entry. Other signature entries' headers may be inspected solely to reject inconsistent use of the
+ * > JWS Unencoded Payload Option, and their headers are not included in the returned result.
+ * > Recipients of a General JWS should only rely on the returned (verified) data.
  *
- * @param jws General JWS.
  * @param key Key to verify the JWS with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWS Verify options.
  */
-export declare function generalVerify(jws: types.GeneralJWSInput, key: types.KeyInput, options?: types.VerifyOptions): Promise<types.GeneralVerifyResult>;
+export declare function generalVerify(jws: t.GeneralJWSInput, key: t.KeyInput, options?: t.VerifyOptions): Promise<t.GeneralVerifyResult>;
 /**
- * Verifies the signature and format of and afterwards decodes the General JWS, resolving the key
- * dynamically. The result additionally carries the {@link types.ResolvedKey.key resolved key}.
+ * Verifies a General JWS signature and decodes its payload, resolving the key dynamically. The
+ * result additionally carries the {@link t.ResolvedKey.key resolved key}.
  *
- * @param jws General JWS.
  * @param getKey Function resolving a key to verify the JWS with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWS Verify options.
  */
-export declare function generalVerify<KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array>(jws: types.GeneralJWSInput, getKey: GeneralVerifyGetKey<KeyType>, options?: types.VerifyOptions): Promise<types.GeneralVerifyResult & types.ResolvedKey<KeyType>>;
+export declare function generalVerify<KeyType extends t.CryptoKey | Uint8Array = t.CryptoKey | Uint8Array>(jws: t.GeneralJWSInput, getKey: GeneralVerifyGetKey<KeyType>, options?: t.VerifyOptions): Promise<t.GeneralVerifyResult & t.ResolvedKey<KeyType>>;
 /**
  * Accepts either form of the `key` argument. Use this overload when forwarding a value that may be
  * either a key or a key resolution function; `key` is present on the result only when a resolution
  * function was used.
  *
- * @param jws General JWS.
  * @param key Key, or function resolving a key, to verify the JWS with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWS Verify options.
  */
-export declare function generalVerify(jws: types.GeneralJWSInput, key: types.KeyInput | GeneralVerifyGetKey, options?: types.VerifyOptions): Promise<types.GeneralVerifyResult & Partial<types.ResolvedKey>>;
+export declare function generalVerify(jws: t.GeneralJWSInput, key: t.KeyInput | GeneralVerifyGetKey, options?: t.VerifyOptions): Promise<t.GeneralVerifyResult & Partial<t.ResolvedKey>>;

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

@@ -1,41 +1,31 @@
-import type * as types from '../types.d.ts';
-/** Combination of JWE Decryption options and JWT Claims Set verification options. */
-export interface JWTDecryptOptions extends types.DecryptOptions, types.JWTClaimVerificationOptions {
+import type * as t from '../types.d.ts';
+/** JWE decryption and JWT Claims Set validation options. */
+export interface JWTDecryptOptions extends t.DecryptOptions, t.JWTClaimVerificationOptions {
 }
-/**
- * Interface for JWT Decryption dynamic key resolution. No token components have been verified at
- * the time of this function call.
- */
-export interface JWTDecryptGetKey<KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array> extends types.GetKeyFunction<types.CompactJWEHeaderParameters, types.FlattenedJWE, KeyType | types.KeyObject | types.JWK> {
+/** Dynamic key resolver for JWT decryption. */
+export interface JWTDecryptGetKey<KeyType extends t.CryptoKey | Uint8Array = t.CryptoKey | Uint8Array> extends t.GetKeyFunction<t.CompactJWEHeaderParameters, t.FlattenedJWE, KeyType | t.KeyObject | t.JWK> {
 }
 /**
- * Verifies the JWT format (to be a JWE Compact format), decrypts the ciphertext, validates the JWT
- * Claims Set.
+ * Decrypts a Compact JWE-formatted JWT and validates its Claims Set.
  *
- * @param jwt JSON Web Token value (encoded as JWE).
  * @param key Private Key or Secret to decrypt and verify the JWT with. See
  *   {@link https://github.com/panva/jose/issues/210#jwe-alg Algorithm Key Requirements}.
- * @param options JWT Decryption and JWT Claims Set validation options.
  */
-export declare function jwtDecrypt<PayloadType = types.JWTPayload>(jwt: string | Uint8Array, key: types.KeyInput, options?: JWTDecryptOptions): Promise<types.JWTDecryptResult<PayloadType>>;
+export declare function jwtDecrypt<PayloadType = t.JWTPayload>(jwt: string | Uint8Array, key: t.KeyInput, options?: JWTDecryptOptions): Promise<t.JWTDecryptResult<PayloadType>>;
 /**
  * Decrypts a JWT and validates its JWT Claims Set, resolving the key dynamically. The result
- * additionally carries the {@link types.ResolvedKey.key resolved key}.
+ * additionally carries the {@link t.ResolvedKey.key resolved key}.
  *
- * @param jwt JSON Web Token value (encoded as JWE).
  * @param getKey Function resolving Private Key or Secret to decrypt and verify the JWT with. See
  *   {@link https://github.com/panva/jose/issues/210#jwe-alg Algorithm Key Requirements}.
- * @param options JWT Decryption and JWT Claims Set validation options.
  */
-export declare function jwtDecrypt<PayloadType = types.JWTPayload, KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array>(jwt: string | Uint8Array, getKey: JWTDecryptGetKey<KeyType>, options?: JWTDecryptOptions): Promise<types.JWTDecryptResult<PayloadType> & types.ResolvedKey<KeyType>>;
+export declare function jwtDecrypt<PayloadType = t.JWTPayload, KeyType extends t.CryptoKey | Uint8Array = t.CryptoKey | Uint8Array>(jwt: string | Uint8Array, getKey: JWTDecryptGetKey<KeyType>, options?: JWTDecryptOptions): Promise<t.JWTDecryptResult<PayloadType> & t.ResolvedKey<KeyType>>;
 /**
  * Accepts either form of the `key` argument. Use this overload when forwarding a value that may be
  * either a key or a key resolution function; `key` is present on the result only when a resolution
  * function was used.
  *
- * @param jwt JSON Web Token value (encoded as JWE).
  * @param key Private Key or Secret, or a function resolving one, to decrypt and verify the JWT
  *   with. See {@link https://github.com/panva/jose/issues/210#jwe-alg Algorithm Key Requirements}.
- * @param options JWT Decryption and JWT Claims Set validation options.
  */
-export declare function jwtDecrypt<PayloadType = types.JWTPayload>(jwt: string | Uint8Array, key: types.KeyInput | JWTDecryptGetKey, options?: JWTDecryptOptions): Promise<types.JWTDecryptResult<PayloadType> & Partial<types.ResolvedKey>>;
+export declare function jwtDecrypt<PayloadType = t.JWTPayload>(jwt: string | Uint8Array, key: t.KeyInput | JWTDecryptGetKey, options?: JWTDecryptOptions): Promise<t.JWTDecryptResult<PayloadType> & Partial<t.ResolvedKey>>;