@suveren/gateway 0.8.0 → 0.8.2

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

@@ -1,5 +1,9 @@
 import type * as t from '../types.d.ts';
-/** Maps a JWK key type to the value returned by {@link importJWK}. */
+/**
+ * Maps a JWK key type to the value returned by {@link importJWK}. An "oct" JWK returns
+ * {@link !Uint8Array}; other supported key types return {@link t.CryptoKey CryptoKey}. A JWK
+ * whose "kty" is not statically known resolves to their union.
+ */
 export type ImportedJWK<JWKType extends t.JWK> = JWKType extends {
     kty: 'oct';
 } ? Uint8Array : JWKType extends {
@@ -8,17 +12,16 @@ export type ImportedJWK<JWKType extends t.JWK> = JWKType extends {
 /** Key import options. */
 export interface KeyImportOptions {
     /**
-     * The value to use as {@link !SubtleCrypto.importKey} `extractable` argument. Default is false for
-     * private keys, true otherwise.
+     * Whether the imported CryptoKey is extractable. Overrides JWK "ext" when set. Without either,
+     * defaults to false for private keys, true otherwise.
      */
     extractable?: boolean;
 }
 /**
  * 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
- * > {@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.
+ * > Note: For RSA keys, use the rsaEncryption OID (1.2.840.113549.1.1.1). The id-RSASSA-PSS OID
+ * > (1.2.840.113549.1.1.10) is not supported by the Web Cryptography API.
  *
  * @param spki PEM-encoded SPKI string
  * @param alg JSON Web Algorithm identifier to be used with the imported key. See
@@ -26,11 +29,10 @@ export interface KeyImportOptions {
  */
 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}.
+ * Imports a PEM-encoded X.509 certificate's public key as a {@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
- * > (1.2.840.113549.1.1.1) instead for all RSA algorithms.
+ * > Note: For RSA keys, use the rsaEncryption OID (1.2.840.113549.1.1.1). The id-RSASSA-PSS OID
+ * > (1.2.840.113549.1.1.10) is not supported by the Web Cryptography API.
  *
  * @param x509 X.509 certificate string
  * @param alg JSON Web Algorithm identifier to be used with the imported key. See
@@ -40,9 +42,8 @@ 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
- * > {@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.
+ * > Note: For RSA keys, use the rsaEncryption OID (1.2.840.113549.1.1.1). The id-RSASSA-PSS OID
+ * > (1.2.840.113549.1.1.10) is not supported by the Web Cryptography API.
  *
  * @param pkcs8 PEM-encoded PKCS#8 string
  * @param alg JSON Web Algorithm identifier to be used with the imported key. See
@@ -50,13 +51,13 @@ export declare function importX509(x509: string, alg: string, options?: KeyImpor
  */
 export declare function importPKCS8(pkcs8: string, alg: string, options?: KeyImportOptions): Promise<t.CryptoKey>;
 /**
- * Imports a JWK as a {@link !CryptoKey} or {@link !Uint8Array}.
+ * Imports a JWK as a {@link !CryptoKey} or {@link !Uint8Array}. Asymmetric imports require either the
+ * "alg" argument or JWK "alg" parameter. For AKP keys, the JWK "alg" parameter is required and must
+ * match the argument when provided.
  *
- * > Note: The JSON Web Key parameters "key_ops" and "ext" are also used in the {@link !CryptoKey} import
- * > process.
+ * > Note: CryptoKey imports honor the JWK "key_ops" and "ext" parameters.
  *
- * > Note: Symmetric JSON Web Keys (i.e. `kty: "oct"`) yield back an {@link !Uint8Array} instead of a
- * > {@link !CryptoKey}.
+ * > Note: Symmetric JWKs (`kty: "oct"`) return {@link !Uint8Array} instead of CryptoKey.
  *
  * @param jwk JSON Web Key.
  * @param alg JSON Web Algorithm identifier to be used with the imported key. Default is the "alg"