jose 4.12.1 → 4.13.0

package/README.md

@@ -38,7 +38,7 @@ const jose = require('jose')
 
 **`example`** Deno import
 ```js
-import * as jose from 'https://deno.land/x/jose@v4.12.1/index.ts'
+import * as jose from 'https://deno.land/x/jose@v4.13.0/index.ts'
 ```
 
 - JSON Web Tokens (JWT)

package/dist/browser/jwk/embedded.js

@@ -4,7 +4,7 @@ import { JWSInvalid } from '../util/errors.js';
 export async function EmbeddedJWK(protectedHeader, token) {
     const joseHeader = {
         ...protectedHeader,
-        ...token.header,
+        ...token === null || token === void 0 ? void 0 : token.header,
     };
     if (!isObject(joseHeader.jwk)) {
         throw new JWSInvalid('"jwk" (JSON Web Key) Header Parameter must be a JSON object');

package/dist/browser/jwks/local.js

@@ -100,14 +100,17 @@ export class LocalJWKSet {
 async function importWithAlgCache(cache, jwk, alg) {
     const cached = cache.get(jwk) || cache.set(jwk, {}).get(jwk);
     if (cached[alg] === undefined) {
-        const keyObject = await importJWK({ ...jwk, ext: true }, alg);
-        if (keyObject.type !== 'public') {
+        const key = await importJWK({ ...jwk, ext: true }, alg);
+        if (key instanceof Uint8Array || key.type !== 'public') {
             throw new JWKSInvalid('JSON Web Key Set members must be public keys');
         }
-        cached[alg] = keyObject;
+        cached[alg] = key;
     }
     return cached[alg];
 }
 export function createLocalJWKSet(jwks) {
-    return LocalJWKSet.prototype.getKey.bind(new LocalJWKSet(jwks));
+    const set = new LocalJWKSet(jwks);
+    return async function (protectedHeader, token) {
+        return set.getKey(protectedHeader, token);
+    };
 }

package/dist/browser/jwks/remote.js

@@ -77,5 +77,8 @@ class RemoteJWKSet extends LocalJWKSet {
     }
 }
 export function createRemoteJWKSet(url, options) {
-    return RemoteJWKSet.prototype.getKey.bind(new RemoteJWKSet(url, options));
+    const set = new RemoteJWKSet(url, options);
+    return async function (protectedHeader, token) {
+        return set.getKey(protectedHeader, token);
+    };
 }

package/dist/node/cjs/jwk/embedded.js

@@ -7,7 +7,7 @@ const errors_js_1 = require("../util/errors.js");
 async function EmbeddedJWK(protectedHeader, token) {
     const joseHeader = {
         ...protectedHeader,
-        ...token.header,
+        ...token === null || token === void 0 ? void 0 : token.header,
     };
     if (!(0, is_object_js_1.default)(joseHeader.jwk)) {
         throw new errors_js_1.JWSInvalid('"jwk" (JSON Web Key) Header Parameter must be a JSON object');

package/dist/node/cjs/jwks/local.js

@@ -105,15 +105,18 @@ exports.LocalJWKSet = LocalJWKSet;
 async function importWithAlgCache(cache, jwk, alg) {
     const cached = cache.get(jwk) || cache.set(jwk, {}).get(jwk);
     if (cached[alg] === undefined) {
-        const keyObject = await (0, import_js_1.importJWK)({ ...jwk, ext: true }, alg);
-        if (keyObject.type !== 'public') {
+        const key = await (0, import_js_1.importJWK)({ ...jwk, ext: true }, alg);
+        if (key instanceof Uint8Array || key.type !== 'public') {
             throw new errors_js_1.JWKSInvalid('JSON Web Key Set members must be public keys');
         }
-        cached[alg] = keyObject;
+        cached[alg] = key;
     }
     return cached[alg];
 }
 function createLocalJWKSet(jwks) {
-    return LocalJWKSet.prototype.getKey.bind(new LocalJWKSet(jwks));
+    const set = new LocalJWKSet(jwks);
+    return async function (protectedHeader, token) {
+        return set.getKey(protectedHeader, token);
+    };
 }
 exports.createLocalJWKSet = createLocalJWKSet;

package/dist/node/cjs/jwks/remote.js

@@ -80,6 +80,9 @@ class RemoteJWKSet extends local_js_1.LocalJWKSet {
     }
 }
 function createRemoteJWKSet(url, options) {
-    return RemoteJWKSet.prototype.getKey.bind(new RemoteJWKSet(url, options));
+    const set = new RemoteJWKSet(url, options);
+    return async function (protectedHeader, token) {
+        return set.getKey(protectedHeader, token);
+    };
 }
 exports.createRemoteJWKSet = createRemoteJWKSet;

package/dist/node/esm/jwk/embedded.js

@@ -4,7 +4,7 @@ import { JWSInvalid } from '../util/errors.js';
 export async function EmbeddedJWK(protectedHeader, token) {
     const joseHeader = {
         ...protectedHeader,
-        ...token.header,
+        ...token === null || token === void 0 ? void 0 : token.header,
     };
     if (!isObject(joseHeader.jwk)) {
         throw new JWSInvalid('"jwk" (JSON Web Key) Header Parameter must be a JSON object');

package/dist/node/esm/jwks/local.js

@@ -100,14 +100,17 @@ export class LocalJWKSet {
 async function importWithAlgCache(cache, jwk, alg) {
     const cached = cache.get(jwk) || cache.set(jwk, {}).get(jwk);
     if (cached[alg] === undefined) {
-        const keyObject = await importJWK({ ...jwk, ext: true }, alg);
-        if (keyObject.type !== 'public') {
+        const key = await importJWK({ ...jwk, ext: true }, alg);
+        if (key instanceof Uint8Array || key.type !== 'public') {
             throw new JWKSInvalid('JSON Web Key Set members must be public keys');
         }
-        cached[alg] = keyObject;
+        cached[alg] = key;
     }
     return cached[alg];
 }
 export function createLocalJWKSet(jwks) {
-    return LocalJWKSet.prototype.getKey.bind(new LocalJWKSet(jwks));
+    const set = new LocalJWKSet(jwks);
+    return async function (protectedHeader, token) {
+        return set.getKey(protectedHeader, token);
+    };
 }

package/dist/node/esm/jwks/remote.js

@@ -77,5 +77,8 @@ class RemoteJWKSet extends LocalJWKSet {
     }
 }
 export function createRemoteJWKSet(url, options) {
-    return RemoteJWKSet.prototype.getKey.bind(new RemoteJWKSet(url, options));
+    const set = new RemoteJWKSet(url, options);
+    return async function (protectedHeader, token) {
+        return set.getKey(protectedHeader, token);
+    };
 }

package/dist/types/jwe/compact/decrypt.d.ts

@@ -30,4 +30,4 @@ export declare function compactDecrypt(jwe: string | Uint8Array, key: KeyLike |
  * @param getKey Function resolving Private Key or Secret to decrypt the JWE with.
  * @param options JWE Decryption options.
  */
-export declare function compactDecrypt(jwe: string | Uint8Array, getKey: CompactDecryptGetKey, options?: DecryptOptions): Promise<CompactDecryptResult & ResolvedKey>;
+export declare function compactDecrypt<T extends KeyLike = KeyLike>(jwe: string | Uint8Array, getKey: CompactDecryptGetKey, options?: DecryptOptions): Promise<CompactDecryptResult & ResolvedKey<T>>;

package/dist/types/jwe/flattened/decrypt.d.ts

@@ -40,4 +40,4 @@ export declare function flattenedDecrypt(jwe: FlattenedJWE, key: KeyLike | Uint8
  * @param getKey Function resolving Private Key or Secret to decrypt the JWE with.
  * @param options JWE Decryption options.
  */
-export declare function flattenedDecrypt(jwe: FlattenedJWE, getKey: FlattenedDecryptGetKey, options?: DecryptOptions): Promise<FlattenedDecryptResult & ResolvedKey>;
+export declare function flattenedDecrypt<T extends KeyLike = KeyLike>(jwe: FlattenedJWE, getKey: FlattenedDecryptGetKey, options?: DecryptOptions): Promise<FlattenedDecryptResult & ResolvedKey<T>>;

package/dist/types/jwe/general/decrypt.d.ts

@@ -44,4 +44,4 @@ export declare function generalDecrypt(jwe: GeneralJWE, key: KeyLike | Uint8Arra
  * @param getKey Function resolving Private Key or Secret to decrypt the JWE with.
  * @param options JWE Decryption options.
  */
-export declare function generalDecrypt(jwe: GeneralJWE, getKey: GeneralDecryptGetKey, options?: DecryptOptions): Promise<GeneralDecryptResult & ResolvedKey>;
+export declare function generalDecrypt<T extends KeyLike = KeyLike>(jwe: GeneralJWE, getKey: GeneralDecryptGetKey, options?: DecryptOptions): Promise<GeneralDecryptResult & ResolvedKey<T>>;

package/dist/types/jwk/embedded.d.ts

@@ -1,4 +1,4 @@
-import type { FlattenedJWSInput, JWSHeaderParameters } from '../types';
+import type { KeyLike, FlattenedJWSInput, JWSHeaderParameters } from '../types';
 /**
  * EmbeddedJWK is an implementation of a GetKeyFunction intended to be used with the JWS/JWT verify
  * operations whenever you need to opt-in to verify signatures with a public key embedded in the
@@ -20,4 +20,4 @@ import type { FlattenedJWSInput, JWSHeaderParameters } from '../types';
  * console.log(payload)
  * ```
  */
-export declare function EmbeddedJWK(protectedHeader: JWSHeaderParameters, token: FlattenedJWSInput): Promise<import("../types.d").KeyLike>;
+export declare function EmbeddedJWK<T extends KeyLike = KeyLike>(protectedHeader?: JWSHeaderParameters, token?: FlattenedJWSInput): Promise<T>;

package/dist/types/jwks/local.d.ts

@@ -2,11 +2,11 @@ import type { KeyLike, JWSHeaderParameters, JSONWebKeySet, FlattenedJWSInput } f
 /** @private */
 export declare function isJWKSLike(jwks: unknown): jwks is JSONWebKeySet;
 /** @private */
-export declare class LocalJWKSet {
+export declare class LocalJWKSet<T extends KeyLike = KeyLike> {
     protected _jwks?: JSONWebKeySet;
     private _cached;
     constructor(jwks: unknown);
-    getKey(protectedHeader?: JWSHeaderParameters, token?: FlattenedJWSInput): Promise<KeyLike>;
+    getKey(protectedHeader?: JWSHeaderParameters, token?: FlattenedJWSInput): Promise<T>;
 }
 /**
  * Returns a function that resolves to a key object from a locally stored, or otherwise available,
@@ -82,4 +82,4 @@ export declare class LocalJWKSet {
  *
  * @param jwks JSON Web Key Set formatted object.
  */
-export declare function createLocalJWKSet(jwks: JSONWebKeySet): (protectedHeader?: JWSHeaderParameters | undefined, token?: FlattenedJWSInput | undefined) => Promise<KeyLike>;
+export declare function createLocalJWKSet<T extends KeyLike = KeyLike>(jwks: JSONWebKeySet): (protectedHeader?: JWSHeaderParameters, token?: FlattenedJWSInput) => Promise<T>;

package/dist/types/jwks/remote.d.ts

@@ -89,4 +89,4 @@ export interface RemoteJWKSetOptions {
  * @param url URL to fetch the JSON Web Key Set from.
  * @param options Options for the remote JSON Web Key Set.
  */
-export declare function createRemoteJWKSet(url: URL, options?: RemoteJWKSetOptions): (protectedHeader?: JWSHeaderParameters | undefined, token?: FlattenedJWSInput | undefined) => Promise<KeyLike>;
+export declare function createRemoteJWKSet<T extends KeyLike = KeyLike>(url: URL, options?: RemoteJWKSetOptions): (protectedHeader?: JWSHeaderParameters, token?: FlattenedJWSInput) => Promise<T>;

package/dist/types/jws/compact/verify.d.ts

@@ -34,4 +34,4 @@ export declare function compactVerify(jws: string | Uint8Array, key: KeyLike | U
  * @param getKey Function resolving a key to verify the JWS with.
  * @param options JWS Verify options.
  */
-export declare function compactVerify(jws: string | Uint8Array, getKey: CompactVerifyGetKey, options?: VerifyOptions): Promise<CompactVerifyResult & ResolvedKey>;
+export declare function compactVerify<T extends KeyLike = KeyLike>(jws: string | Uint8Array, getKey: CompactVerifyGetKey, options?: VerifyOptions): Promise<CompactVerifyResult & ResolvedKey<T>>;

package/dist/types/jws/flattened/verify.d.ts

@@ -39,4 +39,4 @@ export declare function flattenedVerify(jws: FlattenedJWSInput, key: KeyLike | U
  * @param getKey Function resolving a key to verify the JWS with.
  * @param options JWS Verify options.
  */
-export declare function flattenedVerify(jws: FlattenedJWSInput, getKey: FlattenedVerifyGetKey, options?: VerifyOptions): Promise<FlattenedVerifyResult & ResolvedKey>;
+export declare function flattenedVerify<T extends KeyLike = KeyLike>(jws: FlattenedJWSInput, getKey: FlattenedVerifyGetKey, options?: VerifyOptions): Promise<FlattenedVerifyResult & ResolvedKey<T>>;

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

@@ -42,4 +42,4 @@ export declare function generalVerify(jws: GeneralJWSInput, key: KeyLike | Uint8
  * @param getKey Function resolving a key to verify the JWS with.
  * @param options JWS Verify options.
  */
-export declare function generalVerify(jws: GeneralJWSInput, getKey: GeneralVerifyGetKey, options?: VerifyOptions): Promise<GeneralVerifyResult & ResolvedKey>;
+export declare function generalVerify<T extends KeyLike = KeyLike>(jws: GeneralJWSInput, getKey: GeneralVerifyGetKey, options?: VerifyOptions): Promise<GeneralVerifyResult & ResolvedKey<T>>;

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

@@ -38,4 +38,4 @@ export declare function jwtDecrypt(jwt: string | Uint8Array, key: KeyLike | Uint
  * @param getKey Function resolving Private Key or Secret to decrypt and verify the JWT with.
  * @param options JWT Decryption and JWT Claims Set validation options.
  */
-export declare function jwtDecrypt(jwt: string | Uint8Array, getKey: JWTDecryptGetKey, options?: JWTDecryptOptions): Promise<JWTDecryptResult & ResolvedKey>;
+export declare function jwtDecrypt<T extends KeyLike = KeyLike>(jwt: string | Uint8Array, getKey: JWTDecryptGetKey, options?: JWTDecryptOptions): Promise<JWTDecryptResult & ResolvedKey<T>>;

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

@@ -105,4 +105,4 @@ export declare function jwtVerify(jwt: string | Uint8Array, key: KeyLike | Uint8
  * @param getKey Function resolving a key to verify the JWT with.
  * @param options JWT Decryption and JWT Claims Set validation options.
  */
-export declare function jwtVerify(jwt: string | Uint8Array, getKey: JWTVerifyGetKey, options?: JWTVerifyOptions): Promise<JWTVerifyResult & ResolvedKey>;
+export declare function jwtVerify<T extends KeyLike = KeyLike>(jwt: string | Uint8Array, getKey: JWTVerifyGetKey, options?: JWTVerifyOptions): Promise<JWTVerifyResult & ResolvedKey<T>>;

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

@@ -1,9 +1,9 @@
 import type { KeyLike } from '../types';
-export interface GenerateKeyPairResult {
+export interface GenerateKeyPairResult<T extends KeyLike = KeyLike> {
     /** The generated Private Key. */
-    privateKey: KeyLike;
+    privateKey: T;
     /** Public Key corresponding to the generated Private Key. */
-    publicKey: KeyLike;
+    publicKey: T;
 }
 export interface GenerateKeyPairOptions {
     /**
@@ -41,4 +41,4 @@ export interface GenerateKeyPairOptions {
  * @param alg JWA Algorithm Identifier to be used with the generated key pair.
  * @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<T extends KeyLike = KeyLike>(alg: string, options?: GenerateKeyPairOptions): Promise<GenerateKeyPairResult<T>>;

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

@@ -23,4 +23,4 @@ export interface GenerateSecretOptions {
  * @param alg JWA Algorithm Identifier to be used with the generated secret.
  * @param options Additional options passed down to the secret generation.
  */
-export declare function generateSecret(alg: string, options?: GenerateSecretOptions): Promise<KeyLike | Uint8Array>;
+export declare function generateSecret<T extends KeyLike = KeyLike>(alg: string, options?: GenerateSecretOptions): Promise<T | Uint8Array>;

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

@@ -27,7 +27,7 @@ export interface PEMImportOptions {
  * @param alg (Only effective in Web Crypto API runtimes) JSON Web Algorithm identifier to be used
  *   with the imported key, its presence is only enforced in Web Crypto API runtimes.
  */
-export declare function importSPKI(spki: string, alg: string, options?: PEMImportOptions): Promise<KeyLike>;
+export declare function importSPKI<T extends KeyLike = KeyLike>(spki: string, alg: string, options?: PEMImportOptions): Promise<T>;
 /**
  * Imports the SPKI from an X.509 string certificate as a runtime-specific public key representation
  * (KeyObject or CryptoKey). See [Algorithm Key
@@ -55,7 +55,7 @@ export declare function importSPKI(spki: string, alg: string, options?: PEMImpor
  * @param alg (Only effective in Web Crypto API runtimes) JSON Web Algorithm identifier to be used
  *   with the imported key, its presence is only enforced in Web Crypto API runtimes.
  */
-export declare function importX509(x509: string, alg: string, options?: PEMImportOptions): Promise<KeyLike>;
+export declare function importX509<T extends KeyLike = KeyLike>(x509: string, alg: string, options?: PEMImportOptions): Promise<T>;
 /**
  * Imports a PEM-encoded PKCS#8 string as a runtime-specific private key representation (KeyObject
  * or CryptoKey). See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210) to
@@ -77,7 +77,7 @@ export declare function importX509(x509: string, alg: string, options?: PEMImpor
  * @param alg (Only effective in Web Crypto API runtimes) JSON Web Algorithm identifier to be used
  *   with the imported key, its presence is only enforced in Web Crypto API runtimes.
  */
-export declare function importPKCS8(pkcs8: string, alg: string, options?: PEMImportOptions): Promise<KeyLike>;
+export declare function importPKCS8<T extends KeyLike = KeyLike>(pkcs8: string, alg: string, options?: PEMImportOptions): Promise<T>;
 /**
  * Imports a JWK to a runtime-specific key representation (KeyLike). Either JWK "alg" (Algorithm)
  * Parameter must be present or the optional "alg" argument. When running on a runtime using [Web
@@ -116,4 +116,4 @@ export declare function importPKCS8(pkcs8: string, alg: string, options?: PEMImp
  * @param octAsKeyObject Forces a symmetric key to be imported to a KeyObject or CryptoKey. Default
  *   is true unless JWK "ext" (Extractable) is true.
  */
-export declare function importJWK(jwk: JWK, alg?: string, octAsKeyObject?: boolean): Promise<KeyLike | Uint8Array>;
+export declare function importJWK<T extends KeyLike = KeyLike>(jwk: JWK, alg?: string, octAsKeyObject?: boolean): Promise<T | Uint8Array>;

package/dist/types/types.d.ts

@@ -601,9 +601,9 @@ export interface JWTDecryptResult {
   protectedHeader: CompactJWEHeaderParameters
 }
 
-export interface ResolvedKey {
+export interface ResolvedKey<T extends KeyLike = KeyLike> {
   /** Key resolved from the key resolver function. */
-  key: KeyLike | Uint8Array
+  key: T | Uint8Array
 }
 
 /** Recognized Compact JWS Header Parameters, any other Header Members may also be present. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jose",
-  "version": "4.12.1",
+  "version": "4.13.0",
   "description": "'JSON Web Almost Everything' - JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other Web-interoperable runtimes",
   "keywords": [
     "browser",