@suveren/gateway 0.4.0 → 0.5.0

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

@@ -1,25 +1,14 @@
-/**
- * Verifying JSON Web Signature (JWS) in General JSON Serialization
- *
- * @module
- */
 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.
- *
- * @see {@link jwks/remote.createRemoteJWKSet createRemoteJWKSet} to verify using a remote JSON Web Key Set.
  */
-export interface GeneralVerifyGetKey extends types.GenericGetKeyFunction<types.JWSHeaderParameters, types.FlattenedJWSInput, types.CryptoKey | types.KeyObject | types.JWK | Uint8Array> {
+export interface GeneralVerifyGetKey<KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array> extends types.GetKeyFunction<types.JWSHeaderParameters, types.FlattenedJWSInput, KeyType | types.KeyObject | types.JWK> {
 }
 /**
  * Verifies the signature and format of and afterwards decodes the General JWS.
  *
- * This function is exported (as a named export) from the main `'jose'` module entry point as well
- * as from its subpath export `'jose/jws/general/verify'`.
- *
- * > [!NOTE]\
- * > The function iterates over the `signatures` array in the General JWS and returns the verification
+ * > 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
@@ -31,11 +20,25 @@ export interface GeneralVerifyGetKey extends types.GenericGetKeyFunction<types.J
  *   {@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.CryptoKey | types.KeyObject | types.JWK | Uint8Array, options?: types.VerifyOptions): Promise<types.GeneralVerifyResult>;
+export declare function generalVerify(jws: types.GeneralJWSInput, key: types.KeyInput, options?: types.VerifyOptions): Promise<types.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}.
+ *
  * @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(jws: types.GeneralJWSInput, getKey: GeneralVerifyGetKey, options?: types.VerifyOptions): Promise<types.GeneralVerifyResult & types.ResolvedKey>;
+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>>;
+/**
+ * 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>>;

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

@@ -1,8 +1,3 @@
-/**
- * JSON Web Token (JWT) Decryption (JWT is in JWE format)
- *
- * @module
- */
 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 {
@@ -11,25 +6,36 @@ export interface JWTDecryptOptions extends types.DecryptOptions, types.JWTClaimV
  * Interface for JWT Decryption dynamic key resolution. No token components have been verified at
  * the time of this function call.
  */
-export interface JWTDecryptGetKey extends types.GetKeyFunction<types.CompactJWEHeaderParameters, types.FlattenedJWE> {
+export interface JWTDecryptGetKey<KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array> extends types.GetKeyFunction<types.CompactJWEHeaderParameters, types.FlattenedJWE, KeyType | types.KeyObject | types.JWK> {
 }
 /**
  * Verifies the JWT format (to be a JWE Compact format), decrypts the ciphertext, validates the JWT
  * Claims Set.
  *
- * This function is exported (as a named export) from the main `'jose'` module entry point as well
- * as from its subpath export `'jose/jwt/decrypt'`.
- *
  * @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.CryptoKey | types.KeyObject | types.JWK | Uint8Array, options?: JWTDecryptOptions): Promise<types.JWTDecryptResult<PayloadType>>;
+export declare function jwtDecrypt<PayloadType = types.JWTPayload>(jwt: string | Uint8Array, key: types.KeyInput, options?: JWTDecryptOptions): Promise<types.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}.
+ *
  * @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>(jwt: string | Uint8Array, getKey: JWTDecryptGetKey, options?: JWTDecryptOptions): Promise<types.JWTDecryptResult<PayloadType> & types.ResolvedKey>;
+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>>;
+/**
+ * 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>>;

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

@@ -1,16 +1,5 @@
-/**
- * JSON Web Token (JWT) Encryption (JWT is in JWE format)
- *
- * @module
- */
 import type * as types from '../types.d.ts';
-/**
- * The EncryptJWT class is used to build and encrypt Compact JWE formatted JSON Web Tokens.
- *
- * This class is exported (as a named export) from the main `'jose'` module entry point as well as
- * from its subpath export `'jose/jwt/encrypt'`.
- *
- */
+/** The EncryptJWT class is used to build and encrypt Compact JWE formatted JSON Web Tokens. */
 export declare class EncryptJWT implements types.ProduceJWT {
     #private;
     /**
@@ -34,17 +23,16 @@ export declare class EncryptJWT implements types.ProduceJWT {
      */
     setProtectedHeader(protectedHeader: types.CompactJWEHeaderParameters): this;
     /**
-     * Sets the JWE Key Management parameters to be used when encrypting.
-     *
-     * (ECDH-ES) Use of this method is needed for ECDH based algorithms to set the "apu" (Agreement
-     * PartyUInfo) or "apv" (Agreement PartyVInfo) parameters.
+     * 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.
      */
     setKeyManagementParameters(parameters: types.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.
+     * "enc" (Encryption Algorithm) Header Parameter.
      *
      * @deprecated You should not use this method. It is only really intended for test and vector
      *   validation purposes.
@@ -54,7 +42,7 @@ export declare class EncryptJWT implements types.ProduceJWT {
     setContentEncryptionKey(cek: Uint8Array): this;
     /**
      * Sets the JWE Initialization Vector to use for content encryption, by default a random suitable
-     * one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
+     * 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.
@@ -62,23 +50,11 @@ export declare class EncryptJWT implements types.ProduceJWT {
      * @param iv JWE Initialization Vector.
      */
     setInitializationVector(iv: Uint8Array): this;
-    /**
-     * Replicates the "iss" (Issuer) Claim as a JWE Protected Header Parameter.
-     *
-     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-5.3 RFC7519#section-5.3}
-     */
+    /** Replicates the "iss" (Issuer) Claim as a JWE Protected Header Parameter. */
     replicateIssuerAsHeader(): this;
-    /**
-     * Replicates the "sub" (Subject) Claim as a JWE Protected Header Parameter.
-     *
-     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-5.3 RFC7519#section-5.3}
-     */
+    /** Replicates the "sub" (Subject) Claim as a JWE Protected Header Parameter. */
     replicateSubjectAsHeader(): this;
-    /**
-     * Replicates the "aud" (Audience) Claim as a JWE Protected Header Parameter.
-     *
-     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-5.3 RFC7519#section-5.3}
-     */
+    /** Replicates the "aud" (Audience) Claim as a JWE Protected Header Parameter. */
     replicateAudienceAsHeader(): this;
     /**
      * Encrypts and returns the JWT.
@@ -87,5 +63,5 @@ export declare class EncryptJWT implements types.ProduceJWT {
      *   {@link https://github.com/panva/jose/issues/210#jwe-alg Algorithm Key Requirements}.
      * @param options JWE Encryption options.
      */
-    encrypt(key: types.CryptoKey | types.KeyObject | types.JWK | Uint8Array, options?: types.EncryptOptions): Promise<string>;
+    encrypt(key: types.KeyInput, options?: types.EncryptOptions): Promise<string>;
 }

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

@@ -1,16 +1,5 @@
-/**
- * JSON Web Token (JWT) Signing (JWT is in JWS format)
- *
- * @module
- */
 import type * as types from '../types.d.ts';
-/**
- * The SignJWT class is used to build and sign Compact JWS formatted JSON Web Tokens.
- *
- * This class is exported (as a named export) from the main `'jose'` module entry point as well as
- * from its subpath export `'jose/jwt/sign'`.
- *
- */
+/** The SignJWT class is used to build and sign Compact JWS formatted JSON Web Tokens. */
 export declare class SignJWT implements types.ProduceJWT {
     #private;
     /**
@@ -39,5 +28,5 @@ export declare class SignJWT implements types.ProduceJWT {
      *   {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
      * @param options JWT Sign options.
      */
-    sign(key: types.CryptoKey | types.KeyObject | types.JWK | Uint8Array, options?: types.SignOptions): Promise<string>;
+    sign(key: types.KeyInput, options?: types.SignOptions): Promise<string>;
 }

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

@@ -1,21 +1,12 @@
-/**
- * Unsecured (unsigned & unencrypted) JSON Web Tokens (JWT)
- *
- * @module
- */
 import type * as types from '../types.d.ts';
 /** Result of decoding an Unsecured JWT. */
 export interface UnsecuredResult<PayloadType = types.JWTPayload> {
-    payload: PayloadType & types.JWTPayload;
+    /** JWT Claims Set. */
+    payload: PayloadType & types.JWTPayload & ([PayloadType] extends [object] ? unknown : unknown extends PayloadType ? unknown : never);
+    /** The decoded JOSE Header; always `{ "alg": "none" }` for an Unsecured JWT. */
     header: types.JWSHeaderParameters;
 }
-/**
- * The UnsecuredJWT class is a utility for dealing with `{ "alg": "none" }` Unsecured JWTs.
- *
- * This class is exported (as a named export) from the main `'jose'` module entry point as well as
- * from its subpath export `'jose/jwt/unsecured'`.
- *
- */
+/** The UnsecuredJWT class is a utility for dealing with `{ "alg": "none" }` Unsecured JWTs. */
 export declare class UnsecuredJWT implements types.ProduceJWT {
     #private;
     /**

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

@@ -1,8 +1,3 @@
-/**
- * JSON Web Token (JWT) Verification (JWT is in JWS format)
- *
- * @module
- */
 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 {
@@ -10,28 +5,34 @@ export interface JWTVerifyOptions extends types.VerifyOptions, types.JWTClaimVer
 /**
  * Interface for JWT Verification dynamic key resolution. No token components have been verified at
  * the time of this function call.
- *
- * @see {@link jwks/remote.createRemoteJWKSet createRemoteJWKSet} to verify using a remote JSON Web Key Set.
  */
-export interface JWTVerifyGetKey extends types.GenericGetKeyFunction<types.JWTHeaderParameters, types.FlattenedJWSInput, types.CryptoKey | types.KeyObject | types.JWK | Uint8Array> {
+export interface JWTVerifyGetKey<KeyType extends types.CryptoKey | Uint8Array = types.CryptoKey | Uint8Array> extends types.GetKeyFunction<types.CompactJWSHeaderParameters, types.FlattenedJWSInput, KeyType | types.KeyObject | types.JWK> {
 }
 /**
  * Verifies the JWT format (to be a JWS Compact format), verifies the JWS signature, validates the
  * JWT Claims Set.
  *
- * This function is exported (as a named export) from the main `'jose'` module entry point as well
- * as from its subpath export `'jose/jwt/verify'`.
- *
  * @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.CryptoKey | types.KeyObject | types.JWK | Uint8Array, options?: JWTVerifyOptions): Promise<types.JWTVerifyResult<PayloadType>>;
+export declare function jwtVerify<PayloadType = types.JWTPayload>(jwt: string | Uint8Array, key: types.KeyInput, options?: JWTVerifyOptions): Promise<types.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>(jwt: string | Uint8Array, getKey: JWTVerifyGetKey, options?: JWTVerifyOptions): Promise<types.JWTVerifyResult<PayloadType> & types.ResolvedKey>;
+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>>;
+/**
+ * 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>>;

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

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

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

@@ -1,9 +1,9 @@
+import type * as types from '../types.d.ts';
 /**
- * Asymmetric key generation
- *
- * @module
+ * JWA Algorithm Identifiers that {@link generateKeyPair} is able to generate a key pair for, subject
+ * to runtime support.
  */
-import type * as types from '../types.d.ts';
+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. */
 export interface GenerateKeyPairResult {
     /** The generated Private Key. */
@@ -23,25 +23,18 @@ export interface GenerateKeyPairOptions {
      * JOSE requires 2048 bits or larger. Default is 2048.
      */
     modulusLength?: number;
-    /**
-     * The value to use as {@link !SubtleCrypto.generateKey} `extractable` argument. Default is false.
-     *
-     */
+    /** The value to use as {@link !SubtleCrypto.generateKey} `extractable` argument. Default is false. */
     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.
  *
- * > [!NOTE]\
- * > The `privateKey` is generated with `extractable` set to `false` by default. See
+ * > Note: The `privateKey` is generated with `extractable` set to `false` by default. See
  * > {@link GenerateKeyPairOptions.extractable} to generate an extractable `privateKey`.
  *
- * This function is exported (as a named export) from the main `'jose'` module entry point as well
- * as from its subpath export `'jose/generate/keypair'`.
- *
  * @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: string, options?: GenerateKeyPairOptions): Promise<GenerateKeyPairResult>;
+export declare function generateKeyPair(alg: GenerateKeyPairAlgorithm, options?: GenerateKeyPairOptions): Promise<GenerateKeyPairResult>;

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

@@ -1,16 +1,23 @@
+import type * as types from '../types.d.ts';
 /**
- * Symmetric key generation
- *
- * @module
+ * JWA Algorithm Identifiers that {@link generateSecret} is able to generate a secret for, subject to
+ * runtime support.
  */
-import type * as types from '../types.d.ts';
+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. */
 export interface GenerateSecretOptions {
     /**
      * The value to use as {@link !SubtleCrypto.generateKey} `extractable` argument. Default is false.
      *
-     * > [!NOTE]\
-     * > Because A128CBC-HS256, A192CBC-HS384, and A256CBC-HS512 secrets cannot be represented as
+     * > Note: Because A128CBC-HS256, A192CBC-HS384, and A256CBC-HS512 secrets cannot be represented as
      * > {@link !CryptoKey} this option has no effect for them.
      */
     extractable?: boolean;
@@ -18,18 +25,13 @@ export interface GenerateSecretOptions {
 /**
  * Generates a symmetric secret key for a given JWA algorithm identifier.
  *
- * > [!NOTE]\
- * > The secret key is generated with `extractable` set to `false` by default.
+ * > Note: The secret key is generated with `extractable` set to `false` by default.
  *
- * > [!NOTE]\
- * > Because A128CBC-HS256, A192CBC-HS384, and A256CBC-HS512 secrets cannot be represented as
+ * > Note: Because A128CBC-HS256, A192CBC-HS384, and A256CBC-HS512 secrets cannot be represented as
  * > {@link !CryptoKey} this method yields a {@link !Uint8Array} for them instead.
  *
- * This function is exported (as a named export) from the main `'jose'` module entry point as well
- * as from its subpath export `'jose/generate/secret'`.
- *
  * @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: string, options?: GenerateSecretOptions): Promise<types.CryptoKey | Uint8Array>;
+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,9 +1,16 @@
+import type * as types from '../types.d.ts';
 /**
- * Cryptographic key import functions
- *
- * @module
+ * 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.
  */
-import type * as types from '../types.d.ts';
+export type ImportedJWK<JWKType extends types.JWK> = JWKType extends {
+    kty: 'oct';
+} ? Uint8Array : JWKType extends {
+    kty: 'AKP' | 'EC' | 'OKP' | 'RSA';
+} ? types.CryptoKey : types.CryptoKey | Uint8Array;
 /** Key Import Function options. */
 export interface KeyImportOptions {
     /**
@@ -15,14 +22,10 @@ export interface KeyImportOptions {
 /**
  * Imports a PEM-encoded SPKI string as a {@link !CryptoKey}.
  *
- * > [!NOTE]\
- * > The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
+ * > 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
  * > (1.2.840.113549.1.1.1) instead for all RSA algorithms.
  *
- * 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'`.
- *
  * @param spki PEM-encoded SPKI string
  * @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}.
@@ -31,14 +34,10 @@ export declare function importSPKI(spki: string, alg: string, options?: KeyImpor
 /**
  * Imports the SPKI from an X.509 string certificate as a {@link !CryptoKey}.
  *
- * > [!NOTE]\
- * > The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
+ * > 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
  * > (1.2.840.113549.1.1.1) instead for all RSA algorithms.
  *
- * 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'`.
- *
  * @param x509 X.509 certificate string
  * @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}.
@@ -47,14 +46,10 @@ export declare function importX509(x509: string, alg: string, options?: KeyImpor
 /**
  * Imports a PEM-encoded PKCS#8 string as a {@link !CryptoKey}.
  *
- * > [!NOTE]\
- * > The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in
+ * > 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
  * > (1.2.840.113549.1.1.1) instead for all RSA algorithms.
  *
- * 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'`.
- *
  * @param pkcs8 PEM-encoded PKCS#8 string
  * @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}.
@@ -64,20 +59,15 @@ export declare function importPKCS8(pkcs8: string, alg: string, options?: KeyImp
  * 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.
  *
- * > [!NOTE]\
- * > The JSON Web Key parameters "use", "key_ops", and "ext" are also used in the {@link !CryptoKey}
- * > import process.
+ * > Note: The JSON Web Key parameters "key_ops" and "ext" are also used in the {@link !CryptoKey} import
+ * > process.
  *
- * > [!NOTE]\
- * > Symmetric JSON Web Keys (i.e. `kty: "oct"`) yield back an {@link !Uint8Array} instead of a
+ * > Note: Symmetric JSON Web Keys (i.e. `kty: "oct"`) yield back an {@link !Uint8Array} instead of a
  * > {@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'`.
- *
  * @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. See
  *   {@link https://github.com/panva/jose/issues/210 Algorithm Key Requirements}.
  */
-export declare function importJWK(jwk: types.JWK, alg?: string, options?: KeyImportOptions): Promise<types.CryptoKey | Uint8Array>;
+export declare function importJWK<JWKType extends types.JWK>(jwk: JWKType, alg?: string, options?: KeyImportOptions): Promise<ImportedJWK<JWKType>>;