jose 3.19.0 → 3.20.3

package/dist/types/types.d.ts

@@ -1,7 +1,100 @@
-/// <reference lib="dom"/>
-import type { KeyObject } from 'crypto'
-export type { KeyObject }
-export type KeyLike = KeyObject | CryptoKey | Uint8Array
+/**
+ * KeyLike are runtime-specific classes representing asymmetric keys or symmetric secrets.
+ * These are instances of
+ * [CryptoKey](https://developer.mozilla.org/en-US/docs/Web/API/CryptoKey) and additionally
+ * [KeyObject](https://nodejs.org/api/crypto.html#crypto_class_keyobject)
+ * in Node.js runtime.
+ * [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
+ * instances are also accepted as symmetric secret representation only.
+ *
+ * [jose/key/import](../modules/key_import.md#readme) functions can be used to import PEM,
+ * or JWK formatted asymmetric keys and certificates to these runtime-specific representations.
+ *
+ * In Node.js the
+ * [Buffer](https://nodejs.org/api/buffer.html#buffer_buffer) class is a subclass of Uint8Array
+ * and so Buffer can be provided for symmetric secrets as well.
+ *
+ * ---
+ *
+ * [KeyObject](https://nodejs.org/api/crypto.html#crypto_class_keyobject) is a representation of a
+ * key/secret available in the Node.js runtime.
+ * In addition to the import functions of this library you may use the
+ * runtime APIs
+ * [crypto.createPublicKey](https://nodejs.org/api/crypto.html#crypto_crypto_createpublickey_key),
+ * [crypto.createPrivateKey](https://nodejs.org/api/crypto.html#crypto_crypto_createprivatekey_key), and
+ * [crypto.createSecretKey](https://nodejs.org/api/crypto.html#crypto_crypto_createsecretkey_key_encoding)
+ * to obtain a KeyObject from your existing key material.
+ *
+ * [CryptoKey](https://developer.mozilla.org/en-US/docs/Web/API/CryptoKey) is a representation of a
+ * key/secret available in the Browser and Deno runtimes.
+ * In addition to the import functions of this library you may use the
+ * [SubtleCrypto.importKey](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey) API
+ * to obtain a CryptoKey from your existing key material.
+ *
+ * ---
+ *
+ * @example Import a PEM-encoded SPKI Public Key
+ * ```js
+ * import { importSPKI } from 'jose/key/import'
+ *
+ * const algorithm = 'ES256'
+ * const spki = `-----BEGIN PUBLIC KEY-----
+ * MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEFlHHWfLk0gLBbsLTcuCrbCqoHqmM
+ * YJepMC+Q+Dd6RBmBiA41evUsNMwLeN+PNFqib+xwi9JkJ8qhZkq8Y/IzGg==
+ * -----END PUBLIC KEY-----`
+ * const ecPublicKey = await importSPKI(spki, algorithm)
+ * ```
+ *
+ * @example Import a X.509 Certificate
+ * ```js
+ * import { importX509 } from 'jose/key/import'
+ *
+ * const algorithm = 'ES256'
+ * const x509 = `-----BEGIN CERTIFICATE-----
+ * MIIBXjCCAQSgAwIBAgIGAXvykuMKMAoGCCqGSM49BAMCMDYxNDAyBgNVBAMMK3Np
+ * QXBNOXpBdk1VaXhXVWVGaGtjZXg1NjJRRzFyQUhXaV96UlFQTVpQaG8wHhcNMjEw
+ * OTE3MDcwNTE3WhcNMjIwNzE0MDcwNTE3WjA2MTQwMgYDVQQDDCtzaUFwTTl6QXZN
+ * VWl4V1VlRmhrY2V4NTYyUUcxckFIV2lfelJRUE1aUGhvMFkwEwYHKoZIzj0CAQYI
+ * KoZIzj0DAQcDQgAE8PbPvCv5D5xBFHEZlBp/q5OEUymq7RIgWIi7tkl9aGSpYE35
+ * UH+kBKDnphJO3odpPZ5gvgKs2nwRWcrDnUjYLDAKBggqhkjOPQQDAgNIADBFAiEA
+ * 1yyMTRe66MhEXID9+uVub7woMkNYd0LhSHwKSPMUUTkCIFQGsfm1ecXOpeGOufAh
+ * v+A1QWZMuTWqYt+uh/YSRNDn
+ * -----END CERTIFICATE-----`
+ * const ecPublicKey = await importX509(x509, algorithm)
+ * ```
+ *
+ * @example Import a PEM-encoded PKCS8 Private Key
+ * ```js
+ * import { importPKCS8 } from 'jose/key/import'
+ *
+ * const algorithm = 'ES256'
+ * const pkcs8 = `-----BEGIN PRIVATE KEY-----
+ * MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgiyvo0X+VQ0yIrOaN
+ * nlrnUclopnvuuMfoc8HHly3505OhRANCAAQWUcdZ8uTSAsFuwtNy4KtsKqgeqYxg
+ * l6kwL5D4N3pEGYGIDjV69Sw0zAt43480WqJv7HCL0mQnyqFmSrxj8jMa
+ * -----END PRIVATE KEY-----`
+ * const ecPrivateKey = await importPKCS8(pkcs8, algorithm)
+ * ```
+ *
+ * @example Import a JSON Web Key (JWK)
+ * ```js
+ * import { importJWK } from 'jose/key/import'
+ *
+ * const ecPublicKey = await importJWK({
+ *   crv: 'P-256',
+ *   kty: 'EC',
+ *   x: 'ySK38C1jBdLwDsNWKzzBHqKYEE5Cgv-qjWvorUXk9fw',
+ *   y: '_LeQBw07cf5t57Iavn4j-BqJsAD1dpoz8gokd3sBsOo'
+ * }, 'ES256')
+ *
+ * const rsaPublicKey = await importJWK({
+ *   kty: 'RSA',
+ *   e: 'AQAB',
+ *   n: '12oBZRhCiZFJLcPg59LkZZ9mdhSMTKAQZYq32k_ti5SBB6jerkh-WzOMAO664r_qyLkqHUSp3u5SbXtseZEpN3XPWGKSxjsy-1JyEFTdLSYe6f9gfrmxkUF_7DTpq0gn6rntP05g2-wFW50YO7mosfdslfrTJYWHFhJALabAeYirYD7-9kqq9ebfFMF4sRRELbv9oi36As6Q9B3Qb5_C1rAzqfao_PCsf9EPsTZsVVVkA5qoIAr47lo1ipfiBPxUCCNSdvkmDTYgvvRm6ZoMjFbvOtgyts55fXKdMWv7I9HMD5HwE9uW839PWA514qhbcIsXEYSFMPMV6fnlsiZvQQ'
+ * }, 'PS256')
+ * ```
+ */
+export type KeyLike = { type: string }
 export interface JWK {
   alg?: string
   crv?: string
@@ -33,7 +126,7 @@ export interface JWK {
   [propName: string]: unknown
 }
 export interface GetKeyFunction<T, T2> {
-  (protectedHeader: T, token: T2): Promise<KeyLike>
+  (protectedHeader: T, token: T2): Promise<KeyLike | Uint8Array>
 }
 export interface FlattenedJWSInput {
   header?: JWSHeaderParameters
@@ -170,5 +263,5 @@ export interface JWTDecryptResult {
   protectedHeader: JWEHeaderParameters
 }
 export interface ResolvedKey {
-  key: KeyLike
+  key: KeyLike | Uint8Array
 }

package/dist/types/util/errors.d.ts

@@ -1,64 +1,72 @@
 export declare class JOSEError extends Error {
-    static code: string;
+    static get code(): string;
     code: string;
     constructor(message?: string);
 }
 export declare class JWTClaimValidationFailed extends JOSEError {
-    static code: string;
+    static get code(): 'ERR_JWT_CLAIM_VALIDATION_FAILED';
+    code: string;
+    claim: string;
+    reason: string;
+    constructor(message: string, claim?: string, reason?: string);
+}
+export declare class JWTExpired extends JOSEError implements JWTClaimValidationFailed {
+    static get code(): 'ERR_JWT_EXPIRED';
     code: string;
     claim: string;
     reason: string;
     constructor(message: string, claim?: string, reason?: string);
 }
 export declare class JOSEAlgNotAllowed extends JOSEError {
-    static code: string;
+    static get code(): 'ERR_JOSE_ALG_NOT_ALLOWED';
     code: string;
 }
 export declare class JOSENotSupported extends JOSEError {
-    static code: string;
+    static get code(): 'ERR_JOSE_NOT_SUPPORTED';
     code: string;
 }
 export declare class JWEDecryptionFailed extends JOSEError {
-    static code: string;
+    static get code(): 'ERR_JWE_DECRYPTION_FAILED';
     code: string;
     message: string;
 }
 export declare class JWEInvalid extends JOSEError {
-    static code: string;
+    static get code(): 'ERR_JWE_INVALID';
     code: string;
 }
 export declare class JWSInvalid extends JOSEError {
-    static code: string;
+    static get code(): 'ERR_JWS_INVALID';
     code: string;
 }
 export declare class JWTInvalid extends JOSEError {
-    static code: string;
+    static get code(): 'ERR_JWT_INVALID';
     code: string;
 }
 export declare class JWKInvalid extends JOSEError {
-    static code: string;
+    static get code(): 'ERR_JWK_INVALID';
     code: string;
 }
 export declare class JWKSInvalid extends JOSEError {
-    static code: string;
+    static get code(): 'ERR_JWKS_INVALID';
     code: string;
 }
 export declare class JWKSNoMatchingKey extends JOSEError {
-    static code: string;
+    static get code(): 'ERR_JWKS_NO_MATCHING_KEY';
     code: string;
     message: string;
 }
 export declare class JWKSMultipleMatchingKeys extends JOSEError {
-    static code: string;
+    static get code(): 'ERR_JWKS_MULTIPLE_MATCHING_KEYS';
     code: string;
     message: string;
 }
-export declare class JWSSignatureVerificationFailed extends JOSEError {
-    static code: string;
+export declare class JWKSTimeout extends JOSEError {
+    static get code(): 'ERR_JWKS_TIMEOUT';
     code: string;
     message: string;
 }
-export declare class JWTExpired extends JWTClaimValidationFailed {
-    static code: string;
+export declare class JWSSignatureVerificationFailed extends JOSEError {
+    static get code(): 'ERR_JWS_SIGNATURE_VERIFICATION_FAILED';
     code: string;
+    message: string;
 }

package/dist/types/util/generate_key_pair.d.ts

@@ -1,7 +1,7 @@
 import type { KeyLike } from '../types';
 export interface GenerateKeyPairResult {
-    privateKey: Exclude<KeyLike, Uint8Array>;
-    publicKey: Exclude<KeyLike, Uint8Array>;
+    privateKey: KeyLike;
+    publicKey: KeyLike;
 }
 export interface GenerateKeyPairOptions {
     crv?: string;

package/dist/types/util/generate_secret.d.ts

@@ -2,6 +2,6 @@ import type { KeyLike } from '../types';
 export interface GenerateSecretOptions {
     extractable?: boolean;
 }
-declare function generateSecret(alg: string, options?: GenerateSecretOptions): Promise<KeyLike>;
+declare function generateSecret(alg: string, options?: GenerateSecretOptions): Promise<KeyLike | Uint8Array>;
 export { generateSecret };
 export default generateSecret;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jose",
-  "version": "3.19.0",
+  "version": "3.20.3",
   "description": "Universal 'JSON Web Almost Everything' - JWA, JWS, JWE, JWT, JWK with no dependencies",
   "keywords": [
     "browser",
@@ -52,6 +52,7 @@
   },
   "license": "MIT",
   "author": "Filip Skokan <panva.ip@gmail.com>",
+  "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",
     "./jwe/compact/decrypt": {
@@ -212,9 +213,7 @@
     "dist/**/*.js",
     "dist/types/**/*.d.ts",
     "!dist/node/webcrypto/**/*",
-    "!dist/types/**/*.i.d.ts",
     "!dist/types/runtime/*",
-    "!dist/types/lib/*",
-    "dist/types/lib/jwt_producer.d.ts"
+    "!dist/types/lib/*"
   ]
 }