@suveren/gateway 0.4.1 → 0.6.0

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>>;