@suveren/gateway 0.7.4 → 0.8.0

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

@@ -1,43 +1,33 @@
-import type * as types from '../types.d.ts';
-/** The EncryptJWT class is used to build and encrypt Compact JWE formatted JSON Web Tokens. */
-export declare class EncryptJWT implements types.ProduceJWT {
+import type * as t from '../types.d.ts';
+/**
+ * EncryptJWT constructor
+ *
+ * @param payload The JWT Claims Set object. Defaults to an empty object.
+ */
+declare const EncryptJWT_base: new (payload?: t.JWTPayload) => t.ProduceJWT;
+/** Builds and encrypts Compact JWE-formatted JSON Web Tokens. */
+export declare class EncryptJWT extends EncryptJWT_base {
     #private;
-    /**
-     * {@link EncryptJWT} constructor
-     *
-     * @param payload The JWT Claims Set object. Defaults to an empty object.
-     */
-    constructor(payload?: types.JWTPayload);
-    setIssuer(issuer: string): this;
-    setSubject(subject: string): this;
-    setAudience(audience: string | string[]): this;
-    setJti(jwtId: string): this;
-    setNotBefore(input: number | string | Date): this;
-    setExpirationTime(input: number | string | Date): this;
-    setIssuedAt(input?: number | string | Date): this;
     /**
      * 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.
      */
-    setProtectedHeader(protectedHeader: types.CompactJWEHeaderParameters): this;
+    setProtectedHeader(protectedHeader: t.CompactJWEHeaderParameters): this;
     /**
-     * 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): this;
+    setKeyManagementParameters(parameters: t.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.
      *
      * @deprecated You should not use this method. It is only really intended for test and vector
      *   validation purposes.
-     *
-     * @param cek JWE Content Encryption Key.
      */
     setContentEncryptionKey(cek: Uint8Array): this;
     /**
@@ -46,8 +36,6 @@ export declare class EncryptJWT implements types.ProduceJWT {
      *
      * @deprecated You should not use this method. It is only really intended for test and vector
      *   validation purposes.
-     *
-     * @param iv JWE Initialization Vector.
      */
     setInitializationVector(iv: Uint8Array): this;
     /** Replicates the "iss" (Issuer) Claim as a JWE Protected Header Parameter. */
@@ -61,7 +49,7 @@ export declare class EncryptJWT implements types.ProduceJWT {
      *
      * @param key Public Key or Secret to encrypt the JWT with. See
      *   {@link https://github.com/panva/jose/issues/210#jwe-alg Algorithm Key Requirements}.
-     * @param options JWE Encryption options.
      */
-    encrypt(key: types.KeyInput, options?: types.EncryptOptions): Promise<string>;
+    encrypt(key: t.KeyInput, options?: t.EncryptOptions): Promise<string>;
 }
+export {};

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

@@ -1,32 +1,25 @@
-import type * as types from '../types.d.ts';
-/** The SignJWT class is used to build and sign Compact JWS formatted JSON Web Tokens. */
-export declare class SignJWT implements types.ProduceJWT {
+import type * as t from '../types.d.ts';
+/**
+ * SignJWT constructor
+ *
+ * @param payload The JWT Claims Set object. Defaults to an empty object.
+ */
+declare const SignJWT_base: new (payload?: t.JWTPayload) => t.ProduceJWT;
+/** Builds and signs Compact JWS-formatted JSON Web Tokens. */
+export declare class SignJWT extends SignJWT_base {
     #private;
-    /**
-     * {@link SignJWT} constructor
-     *
-     * @param payload The JWT Claims Set object. Defaults to an empty object.
-     */
-    constructor(payload?: types.JWTPayload);
-    setIssuer(issuer: string): this;
-    setSubject(subject: string): this;
-    setAudience(audience: string | string[]): this;
-    setJti(jwtId: string): this;
-    setNotBefore(input: number | string | Date): this;
-    setExpirationTime(input: number | string | Date): this;
-    setIssuedAt(input?: number | string | Date): this;
     /**
      * Sets the JWS Protected Header on the SignJWT object.
      *
      * @param protectedHeader JWS Protected Header. Must contain an "alg" (JWS Algorithm) property.
      */
-    setProtectedHeader(protectedHeader: types.JWTHeaderParameters): this;
+    setProtectedHeader(protectedHeader: t.JWTHeaderParameters): this;
     /**
      * Signs and returns the JWT.
      *
      * @param key Private Key or Secret to sign the JWT with. See
      *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
-     * @param options JWT Sign options.
      */
-    sign(key: types.KeyInput, options?: types.SignOptions): Promise<string>;
+    sign(key: t.KeyInput, options?: t.SignOptions): Promise<string>;
 }
+export {};

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

@@ -1,34 +1,23 @@
-import type * as types from '../types.d.ts';
-/** Result of decoding an Unsecured JWT. */
-export interface UnsecuredResult<PayloadType = types.JWTPayload> {
+import type * as t from '../types.d.ts';
+/** Decoded Unsecured JWT. */
+export interface UnsecuredResult<PayloadType = t.JWTPayload> {
     /** JWT Claims Set. */
-    payload: PayloadType & types.JWTPayload & ([PayloadType] extends [object] ? unknown : unknown extends PayloadType ? unknown : never);
+    payload: PayloadType & t.JWTPayload & ([PayloadType] extends [object] ? unknown : unknown extends PayloadType ? unknown : never);
     /** The decoded JOSE Header; always `{ "alg": "none" }` for an Unsecured JWT. */
-    header: types.JWSHeaderParameters;
+    header: t.JWSHeaderParameters;
 }
-/** The UnsecuredJWT class is a utility for dealing with `{ "alg": "none" }` Unsecured JWTs. */
-export declare class UnsecuredJWT implements types.ProduceJWT {
-    #private;
-    /**
-     * {@link UnsecuredJWT} constructor
-     *
-     * @param payload The JWT Claims Set object. Defaults to an empty object.
-     */
-    constructor(payload?: types.JWTPayload);
+/**
+ * UnsecuredJWT constructor
+ *
+ * @param payload The JWT Claims Set object. Defaults to an empty object.
+ */
+declare const UnsecuredJWT_base: new (payload?: t.JWTPayload) => t.ProduceJWT;
+/** Encodes and decodes `{ "alg": "none" }` Unsecured JWTs. */
+export declare class UnsecuredJWT extends UnsecuredJWT_base {
+    private jwt;
     /** Encodes the Unsecured JWT. */
     encode(): string;
-    setIssuer(issuer: string): this;
-    setSubject(subject: string): this;
-    setAudience(audience: string | string[]): this;
-    setJti(jwtId: string): this;
-    setNotBefore(input: number | string | Date): this;
-    setExpirationTime(input: number | string | Date): this;
-    setIssuedAt(input?: number | string | Date): this;
-    /**
-     * Decodes an unsecured JWT.
-     *
-     * @param jwt Unsecured JWT to decode the payload of.
-     * @param options JWT Claims Set validation options.
-     */
-    static decode<PayloadType = types.JWTPayload>(jwt: string, options?: types.JWTClaimVerificationOptions): UnsecuredResult<PayloadType>;
+    /** Decodes an unsecured JWT. */
+    static decode<PayloadType = t.JWTPayload>(jwt: string, options?: t.JWTClaimVerificationOptions): UnsecuredResult<PayloadType>;
 }
+export {};

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

@@ -1,38 +1,28 @@
-import type * as types from '../types.d.ts';
-/** Combination of JWS Verification options and JWT Claims Set verification options. */
-export interface JWTVerifyOptions extends types.VerifyOptions, types.JWTClaimVerificationOptions {
+import type * as t from '../types.d.ts';
+/** JWS verification and JWT Claims Set validation options. */
+export interface JWTVerifyOptions extends t.VerifyOptions, t.JWTClaimVerificationOptions {
 }
-/**
- * Interface for JWT Verification dynamic key resolution. No token components have been verified at
- * the time of this function call.
- */
-export interface JWTVerifyGetKey<KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array> extends types.GetKeyFunction<types.CompactJWSHeaderParameters, types.FlattenedJWSInput, KeyType | types.KeyObject | types.JWK> {
+/** Dynamic key resolver for JWT verification. */
+export interface JWTVerifyGetKey<KeyType extends t.CryptoKey | Uint8Array = t.CryptoKey | Uint8Array> extends t.GetKeyFunction<t.CompactJWSHeaderParameters, t.FlattenedJWSInput, KeyType | t.KeyObject | t.JWK> {
 }
 /**
- * Verifies the JWT format (to be a JWS Compact format), verifies the JWS signature, validates the
- * JWT Claims Set.
+ * Verifies a Compact JWS-formatted JWT and validates its Claims Set.
  *
- * @param jwt JSON Web Token value (encoded as JWS).
  * @param key Key to verify the JWT with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWT Decryption and JWT Claims Set validation options.
  */
-export declare function jwtVerify<PayloadType = types.JWTPayload>(jwt: string | Uint8Array, key: types.KeyInput, options?: JWTVerifyOptions): Promise<types.JWTVerifyResult<PayloadType>>;
+export declare function jwtVerify<PayloadType = t.JWTPayload>(jwt: string | Uint8Array, key: t.KeyInput, options?: JWTVerifyOptions): Promise<t.JWTVerifyResult<PayloadType>>;
 /**
- * @param jwt JSON Web Token value (encoded as JWS).
  * @param getKey Function resolving a key to verify the JWT with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWT Decryption and JWT Claims Set validation options.
  */
-export declare function jwtVerify<PayloadType = types.JWTPayload, KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array>(jwt: string | Uint8Array, getKey: JWTVerifyGetKey<KeyType>, options?: JWTVerifyOptions): Promise<types.JWTVerifyResult<PayloadType> & types.ResolvedKey<KeyType>>;
+export declare function jwtVerify<PayloadType = t.JWTPayload, KeyType extends t.CryptoKey | Uint8Array = t.CryptoKey | Uint8Array>(jwt: string | Uint8Array, getKey: JWTVerifyGetKey<KeyType>, options?: JWTVerifyOptions): Promise<t.JWTVerifyResult<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 JWS).
  * @param key Key, or function resolving a key, to verify the JWT with. See
  *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
- * @param options JWT Decryption and JWT Claims Set validation options.
  */
-export declare function jwtVerify<PayloadType = types.JWTPayload>(jwt: string | Uint8Array, key: types.KeyInput | JWTVerifyGetKey, options?: JWTVerifyOptions): Promise<types.JWTVerifyResult<PayloadType> & Partial<types.ResolvedKey>>;
+export declare function jwtVerify<PayloadType = t.JWTPayload>(jwt: string | Uint8Array, key: t.KeyInput | JWTVerifyGetKey, options?: JWTVerifyOptions): Promise<t.JWTVerifyResult<PayloadType> & Partial<t.ResolvedKey>>;

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

@@ -1,19 +1,19 @@
-import type * as types from '../types.d.ts';
+import type * as t from '../types.d.ts';
 /**
  * Exports a public {@link !CryptoKey} or {@link !KeyObject} to a PEM-encoded SPKI string format.
  *
  * @param key Key to export to a PEM-encoded SPKI string format.
  */
-export declare function exportSPKI(key: types.CryptoKey | types.KeyObject): Promise<string>;
+export declare function exportSPKI(key: t.CryptoKey | t.KeyObject): Promise<string>;
 /**
  * Exports a private {@link !CryptoKey} or {@link !KeyObject} to a PEM-encoded PKCS8 string format.
  *
  * @param key Key to export to a PEM-encoded PKCS8 string format.
  */
-export declare function exportPKCS8(key: types.CryptoKey | types.KeyObject): Promise<string>;
+export declare function exportPKCS8(key: t.CryptoKey | t.KeyObject): Promise<string>;
 /**
  * Exports a {@link !CryptoKey}, {@link !KeyObject}, or {@link !Uint8Array} to a JWK.
  *
  * @param key Key to export as JWK.
  */
-export declare function exportJWK(key: types.CryptoKey | types.KeyObject | Uint8Array): Promise<types.JWK>;
+export declare function exportJWK(key: t.CryptoKey | t.KeyObject | Uint8Array): Promise<t.JWK>;

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

@@ -1,17 +1,17 @@
-import type * as types from '../types.d.ts';
+import type * as t from '../types.d.ts';
 /**
  * JWA Algorithm Identifiers that {@link generateKeyPair} is able to generate a key pair for, subject
  * to runtime support.
  */
 export type GenerateKeyPairAlgorithm = 'PS256' | 'PS384' | 'PS512' | 'RS256' | 'RS384' | 'RS512' | 'RSA-OAEP' | 'RSA-OAEP-256' | 'RSA-OAEP-384' | 'RSA-OAEP-512' | 'ES256' | 'ES384' | 'ES512' | 'Ed25519' | 'EdDSA' | 'ML-DSA-44' | 'ML-DSA-65' | 'ML-DSA-87' | 'ECDH-ES' | 'ECDH-ES+A128KW' | 'ECDH-ES+A192KW' | 'ECDH-ES+A256KW' | (string & {});
-/** Asymmetric key pair generation function result. */
+/** Generated asymmetric key pair. */
 export interface GenerateKeyPairResult {
     /** The generated Private Key. */
-    privateKey: types.CryptoKey;
+    privateKey: t.CryptoKey;
     /** Public Key corresponding to the generated Private Key. */
-    publicKey: types.CryptoKey;
+    publicKey: t.CryptoKey;
 }
-/** Asymmetric key pair generation function options. */
+/** Asymmetric key pair generation options. */
 export interface GenerateKeyPairOptions {
     /**
      * The EC "crv" (Curve) or OKP "crv" (Subtype of Key Pair) value to generate. The curve must be
@@ -27,14 +27,12 @@ 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 an asymmetric key pair for a JWA algorithm identifier.
  *
  * > Note: The `privateKey` is generated with `extractable` set to `false` by default. See
  * > {@link GenerateKeyPairOptions.extractable} to generate an extractable `privateKey`.
  *
  * @param alg JWA Algorithm Identifier to be used with the generated key pair. See
  *   {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}.
- * @param options Additional options passed down to the key pair generation.
  */
 export declare function generateKeyPair(alg: GenerateKeyPairAlgorithm, options?: GenerateKeyPairOptions): Promise<GenerateKeyPairResult>;

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

@@ -1,18 +1,12 @@
-import type * as types from '../types.d.ts';
+import type * as t from '../types.d.ts';
 /**
  * JWA Algorithm Identifiers that {@link generateSecret} is able to generate a secret for, subject to
  * runtime support.
  */
 export type GenerateSecretAlgorithm = 'HS256' | 'HS384' | 'HS512' | 'A128CBC-HS256' | 'A192CBC-HS384' | 'A256CBC-HS512' | 'A128KW' | 'A192KW' | 'A256KW' | 'A128GCMKW' | 'A192GCMKW' | 'A256GCMKW' | 'A128GCM' | 'A192GCM' | 'A256GCM' | (string & {});
-/**
- * Resolves what {@link generateSecret} returns for a given JWA Algorithm Identifier. The
- * AES_CBC_HMAC_SHA2 content encryption algorithms have no {@link !CryptoKey} representation, so they
- * yield a {@link !Uint8Array}; every other supported identifier yields a
- * {@link types.CryptoKey CryptoKey}. When the identifier is not statically known this resolves to
- * their union.
- */
-export type GeneratedSecret<Alg extends string> = Alg extends 'A128CBC-HS256' | 'A192CBC-HS384' | 'A256CBC-HS512' ? Uint8Array : string extends Alg ? types.CryptoKey | Uint8Array : types.CryptoKey;
-/** Secret generation function options. */
+/** Maps a JWA algorithm identifier to the value returned by {@link generateSecret}. */
+export type GeneratedSecret<Alg extends string> = Alg extends 'A128CBC-HS256' | 'A192CBC-HS384' | 'A256CBC-HS512' ? Uint8Array : string extends Alg ? t.CryptoKey | Uint8Array : t.CryptoKey;
+/** Secret generation options. */
 export interface GenerateSecretOptions {
     /**
      * The value to use as {@link !SubtleCrypto.generateKey} `extractable` argument. Default is false.
@@ -32,6 +26,5 @@ export interface GenerateSecretOptions {
  *
  * @param alg JWA Algorithm Identifier to be used with the generated secret. See
  *   {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}.
- * @param options Additional options passed down to the secret generation.
  */
 export declare function generateSecret<Alg extends GenerateSecretAlgorithm>(alg: Alg, options?: GenerateSecretOptions): Promise<GeneratedSecret<Alg>>;

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

@@ -1,17 +1,11 @@
-import type * as types from '../types.d.ts';
-/**
- * Resolves what {@link importJWK} returns for a given JWK type. The "kty" (Key Type) Parameter fully
- * determines the outcome at runtime: `"oct"` yields a {@link !Uint8Array} secret, every other
- * supported key type yields a {@link types.CryptoKey CryptoKey}. When "kty" is not statically known
- * — the usual case for a JWK parsed from JSON, or for a value typed as {@link types.JWK JWK} — this
- * resolves to their union.
- */
-export type ImportedJWK<JWKType extends types.JWK> = JWKType extends {
+import type * as t from '../types.d.ts';
+/** Maps a JWK key type to the value returned by {@link importJWK}. */
+export type ImportedJWK<JWKType extends t.JWK> = JWKType extends {
     kty: 'oct';
 } ? Uint8Array : JWKType extends {
     kty: 'AKP' | 'EC' | 'OKP' | 'RSA';
-} ? types.CryptoKey : types.CryptoKey | Uint8Array;
-/** Key Import Function options. */
+} ? t.CryptoKey : t.CryptoKey | Uint8Array;
+/** Key import options. */
 export interface KeyImportOptions {
     /**
      * The value to use as {@link !SubtleCrypto.importKey} `extractable` argument. Default is false for
@@ -30,7 +24,7 @@ export interface KeyImportOptions {
  * @param alg JSON Web Algorithm identifier to be used with the imported key. See
  *   {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}.
  */
-export declare function importSPKI(spki: string, alg: string, options?: KeyImportOptions): Promise<types.CryptoKey>;
+export declare function importSPKI(spki: string, alg: string, options?: KeyImportOptions): Promise<t.CryptoKey>;
 /**
  * Imports the SPKI from an X.509 string certificate as a {@link !CryptoKey}.
  *
@@ -42,7 +36,7 @@ export declare function importSPKI(spki: string, alg: string, options?: KeyImpor
  * @param alg JSON Web Algorithm identifier to be used with the imported key. See
  *   {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}.
  */
-export declare function importX509(x509: string, alg: string, options?: KeyImportOptions): Promise<types.CryptoKey>;
+export declare function importX509(x509: string, alg: string, options?: KeyImportOptions): Promise<t.CryptoKey>;
 /**
  * Imports a PEM-encoded PKCS#8 string as a {@link !CryptoKey}.
  *
@@ -54,10 +48,9 @@ export declare function importX509(x509: string, alg: string, options?: KeyImpor
  * @param alg JSON Web Algorithm identifier to be used with the imported key. See
  *   {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}.
  */
-export declare function importPKCS8(pkcs8: string, alg: string, options?: KeyImportOptions): Promise<types.CryptoKey>;
+export declare function importPKCS8(pkcs8: string, alg: string, options?: KeyImportOptions): Promise<t.CryptoKey>;
 /**
- * Imports a JWK to a {@link !CryptoKey}. Either the JWK "alg" (Algorithm) Parameter, or the optional
- * "alg" argument, must be present for asymmetric JSON Web Key imports.
+ * Imports a JWK as a {@link !CryptoKey} or {@link !Uint8Array}.
  *
  * > Note: The JSON Web Key parameters "key_ops" and "ext" are also used in the {@link !CryptoKey} import
  * > process.
@@ -70,4 +63,4 @@ export declare function importPKCS8(pkcs8: string, alg: string, options?: KeyImp
  *   property on the JWK. See
  *   {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}.
  */
-export declare function importJWK<JWKType extends types.JWK>(jwk: JWKType, alg?: string, options?: KeyImportOptions): Promise<ImportedJWK<JWKType>>;
+export declare function importJWK<JWKType extends t.JWK>(jwk: JWKType, alg?: string, options?: KeyImportOptions): Promise<ImportedJWK<JWKType>>;