jose 6.0.0 → 6.0.2

package/dist/types/index.d.ts

@@ -1,48 +1,54 @@
-export { compactDecrypt } from './jwe/compact/decrypt';
-export type { CompactDecryptGetKey } from './jwe/compact/decrypt';
-export { flattenedDecrypt } from './jwe/flattened/decrypt';
-export type { FlattenedDecryptGetKey } from './jwe/flattened/decrypt';
-export { generalDecrypt } from './jwe/general/decrypt';
-export type { GeneralDecryptGetKey } from './jwe/general/decrypt';
-export { GeneralEncrypt } from './jwe/general/encrypt';
-export type { Recipient } from './jwe/general/encrypt';
-export { compactVerify } from './jws/compact/verify';
-export type { CompactVerifyGetKey } from './jws/compact/verify';
-export { flattenedVerify } from './jws/flattened/verify';
-export type { FlattenedVerifyGetKey } from './jws/flattened/verify';
-export { generalVerify } from './jws/general/verify';
-export type { GeneralVerifyGetKey } from './jws/general/verify';
-export { jwtVerify } from './jwt/verify';
-export type { JWTVerifyOptions, JWTVerifyGetKey } from './jwt/verify';
-export { jwtDecrypt } from './jwt/decrypt';
-export type { JWTDecryptOptions, JWTDecryptGetKey } from './jwt/decrypt';
-export type { ProduceJWT } from './jwt/produce';
-export { CompactEncrypt } from './jwe/compact/encrypt';
-export { FlattenedEncrypt } from './jwe/flattened/encrypt';
-export { CompactSign } from './jws/compact/sign';
-export { FlattenedSign } from './jws/flattened/sign';
-export { GeneralSign } from './jws/general/sign';
-export type { Signature } from './jws/general/sign';
-export { SignJWT } from './jwt/sign';
-export { EncryptJWT } from './jwt/encrypt';
-export { calculateJwkThumbprint, calculateJwkThumbprintUri } from './jwk/thumbprint';
-export { EmbeddedJWK } from './jwk/embedded';
-export { createLocalJWKSet } from './jwks/local';
-export { createRemoteJWKSet, jwksCache } from './jwks/remote';
-export type { RemoteJWKSetOptions, JWKSCacheInput, ExportedJWKSCache, customFetch, FetchImplementation, } from './jwks/remote';
-export { UnsecuredJWT } from './jwt/unsecured';
-export type { UnsecuredResult } from './jwt/unsecured';
-export { exportPKCS8, exportSPKI, exportJWK } from './key/export';
-export { importSPKI, importPKCS8, importX509, importJWK } from './key/import';
-export type { KeyImportOptions } from './key/import';
-export { decodeProtectedHeader } from './util/decode_protected_header';
-export { decodeJwt } from './util/decode_jwt';
-export type { ProtectedHeaderParameters } from './util/decode_protected_header';
-export * as errors from './util/errors';
-export { generateKeyPair } from './key/generate_key_pair';
-export type { GenerateKeyPairResult, GenerateKeyPairOptions } from './key/generate_key_pair';
-export { generateSecret } from './key/generate_secret';
-export type { GenerateSecretOptions } from './key/generate_secret';
-export * as base64url from './util/base64url';
-export type { CompactDecryptResult, CompactJWEHeaderParameters, CompactJWSHeaderParameters, CompactVerifyResult, CritOption, CryptoKey, DecryptOptions, EncryptOptions, FlattenedDecryptResult, FlattenedJWE, FlattenedJWS, FlattenedJWSInput, FlattenedVerifyResult, GeneralDecryptResult, GeneralJWE, GeneralJWS, GeneralJWSInput, GeneralVerifyResult, GetKeyFunction, JoseHeaderParameters, JSONWebKeySet, JWEHeaderParameters, JWEKeyManagementHeaderParameters, JWK_EC_Private, JWK_EC_Public, JWK_oct, JWK_OKP_Private, JWK_OKP_Public, JWK_RSA_Private, JWK_RSA_Public, JWK, JWKParameters, JWSHeaderParameters, JWTClaimVerificationOptions, JWTDecryptResult, JWTHeaderParameters, JWTPayload, JWTVerifyResult, KeyObject, ResolvedKey, SignOptions, VerifyOptions, } from './types';
+/**
+ * JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other
+ * Web-interoperable runtimes
+ *
+ * @module jose
+ */
+export { compactDecrypt } from './jwe/compact/decrypt.js';
+export type { CompactDecryptGetKey } from './jwe/compact/decrypt.js';
+export { flattenedDecrypt } from './jwe/flattened/decrypt.js';
+export type { FlattenedDecryptGetKey } from './jwe/flattened/decrypt.js';
+export { generalDecrypt } from './jwe/general/decrypt.js';
+export type { GeneralDecryptGetKey } from './jwe/general/decrypt.js';
+export { GeneralEncrypt } from './jwe/general/encrypt.js';
+export type { Recipient } from './jwe/general/encrypt.js';
+export { compactVerify } from './jws/compact/verify.js';
+export type { CompactVerifyGetKey } from './jws/compact/verify.js';
+export { flattenedVerify } from './jws/flattened/verify.js';
+export type { FlattenedVerifyGetKey } from './jws/flattened/verify.js';
+export { generalVerify } from './jws/general/verify.js';
+export type { GeneralVerifyGetKey } from './jws/general/verify.js';
+export { jwtVerify } from './jwt/verify.js';
+export type { JWTVerifyOptions, JWTVerifyGetKey } from './jwt/verify.js';
+export { jwtDecrypt } from './jwt/decrypt.js';
+export type { JWTDecryptOptions, JWTDecryptGetKey } from './jwt/decrypt.js';
+export type { ProduceJWT } from './jwt/produce.js';
+export { CompactEncrypt } from './jwe/compact/encrypt.js';
+export { FlattenedEncrypt } from './jwe/flattened/encrypt.js';
+export { CompactSign } from './jws/compact/sign.js';
+export { FlattenedSign } from './jws/flattened/sign.js';
+export { GeneralSign } from './jws/general/sign.js';
+export type { Signature } from './jws/general/sign.js';
+export { SignJWT } from './jwt/sign.js';
+export { EncryptJWT } from './jwt/encrypt.js';
+export { calculateJwkThumbprint, calculateJwkThumbprintUri } from './jwk/thumbprint.js';
+export { EmbeddedJWK } from './jwk/embedded.js';
+export { createLocalJWKSet } from './jwks/local.js';
+export { createRemoteJWKSet, jwksCache } from './jwks/remote.js';
+export type { RemoteJWKSetOptions, JWKSCacheInput, ExportedJWKSCache, customFetch, FetchImplementation, } from './jwks/remote.js';
+export { UnsecuredJWT } from './jwt/unsecured.js';
+export type { UnsecuredResult } from './jwt/unsecured.js';
+export { exportPKCS8, exportSPKI, exportJWK } from './key/export.js';
+export { importSPKI, importPKCS8, importX509, importJWK } from './key/import.js';
+export type { KeyImportOptions } from './key/import.js';
+export { decodeProtectedHeader } from './util/decode_protected_header.js';
+export { decodeJwt } from './util/decode_jwt.js';
+export type { ProtectedHeaderParameters } from './util/decode_protected_header.js';
+export * as errors from './util/errors.js';
+export { generateKeyPair } from './key/generate_key_pair.js';
+export type { GenerateKeyPairResult, GenerateKeyPairOptions } from './key/generate_key_pair.js';
+export { generateSecret } from './key/generate_secret.js';
+export type { GenerateSecretOptions } from './key/generate_secret.js';
+export * as base64url from './util/base64url.js';
+export type { CompactDecryptResult, CompactJWEHeaderParameters, CompactJWSHeaderParameters, CompactVerifyResult, CritOption, CryptoKey, DecryptOptions, EncryptOptions, FlattenedDecryptResult, FlattenedJWE, FlattenedJWS, FlattenedJWSInput, FlattenedVerifyResult, GeneralDecryptResult, GeneralJWE, GeneralJWS, GeneralJWSInput, GeneralVerifyResult, GetKeyFunction, JoseHeaderParameters, JSONWebKeySet, JWEHeaderParameters, JWEKeyManagementHeaderParameters, JWK_EC_Private, JWK_EC_Public, JWK_oct, JWK_OKP_Private, JWK_OKP_Public, JWK_RSA_Private, JWK_RSA_Public, JWK, JWKParameters, JWSHeaderParameters, JWTClaimVerificationOptions, JWTDecryptResult, JWTHeaderParameters, JWTPayload, JWTVerifyResult, KeyObject, ResolvedKey, SignOptions, VerifyOptions, } from './types.d.ts';
 export declare const cryptoRuntime = "WebCryptoAPI";

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * Decrypting JSON Web Encryption (JWE) in Compact Serialization
+ *
+ * @module
+ */
+import type * as types from '../../types.d.ts';
 /**
  * Interface for Compact JWE Decryption dynamic key resolution. No token components have been
  * verified at the time of this function call.

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * Encrypting JSON Web Encryption (JWE) in Compact Serialization
+ *
+ * @module
+ */
+import type * as types from '../../types.d.ts';
 /**
  * The CompactEncrypt class is used to build and encrypt Compact JWE strings.
  *

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * Decrypting JSON Web Encryption (JWE) in Flattened JSON Serialization
+ *
+ * @module
+ */
+import type * as types from '../../types.d.ts';
 /**
  * Interface for Flattened JWE Decryption dynamic key resolution. No token components have been
  * verified at the time of this function call.

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * Encrypting JSON Web Encryption (JWE) in Flattened JSON Serialization
+ *
+ * @module
+ */
+import type * as types from '../../types.d.ts';
 /**
  * The FlattenedEncrypt class is used to build and encrypt Flattened JWE objects.
  *

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * Decrypting JSON Web Encryption (JWE) in General JSON Serialization
+ *
+ * @module
+ */
+import type * as types from '../../types.d.ts';
 /**
  * Interface for General JWE Decryption dynamic key resolution. No token components have been
  * verified at the time of this function call.

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * Encrypting JSON Web Encryption (JWE) in General JSON Serialization
+ *
+ * @module
+ */
+import type * as types from '../../types.d.ts';
 export interface Recipient {
     /**
      * Sets the JWE Per-Recipient Unprotected Header on the Recipient object.

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * Verification using a JWK Embedded in a JWS Header
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
 /**
  * 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

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * JSON Web Key Thumbprint and JSON Web Key Thumbprint URI
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
 /**
  * Calculates a base64url-encoded JSON Web Key (JWK) Thumbprint
  *

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * Verification using a JSON Web Key Set (JWKS) available locally
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
 /**
  * Returns a function that resolves a JWS JOSE Header to a public key object from a locally stored,
  * or otherwise available, JSON Web Key Set.

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * Verification using a JSON Web Key Set (JWKS) available on an HTTP(S) URL
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
 /**
  * When passed to {@link jwks/remote.createRemoteJWKSet createRemoteJWKSet} this allows the resolver
  * to make use of advanced fetch configurations, HTTP Proxies, retry on network errors, etc.

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * Signing JSON Web Signature (JWS) in Compact Serialization
+ *
+ * @module
+ */
+import type * as types from '../../types.d.ts';
 /**
  * The CompactSign class is used to build and sign Compact JWS strings.
  *

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * Verifying JSON Web Signature (JWS) in Compact Serialization
+ *
+ * @module
+ */
+import type * as types from '../../types.d.ts';
 /**
  * Interface for Compact JWS Verification dynamic key resolution. No token components have been
  * verified at the time of this function call.

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * Signing JSON Web Signature (JWS) in Flattened JSON Serialization
+ *
+ * @module
+ */
+import type * as types from '../../types.d.ts';
 /**
  * The FlattenedSign class is used to build and sign Flattened JWS objects.
  *

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * Verifying JSON Web Signature (JWS) in Flattened JSON Serialization
+ *
+ * @module
+ */
+import type * as types from '../../types.d.ts';
 /**
  * Interface for Flattened JWS Verification dynamic key resolution. No token components have been
  * verified at the time of this function call.

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * Signing JSON Web Signature (JWS) in General JSON Serialization
+ *
+ * @module
+ */
+import type * as types from '../../types.d.ts';
 export interface Signature {
     /**
      * Sets the JWS Protected Header on the Signature object.

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

@@ -1,4 +1,9 @@
-import type * as types from '../../types';
+/**
+ * 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.

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * 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 {
 }

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

@@ -1,5 +1,10 @@
-import type * as types from '../types';
-import { ProduceJWT } from './produce';
+/**
+ * JSON Web Token (JWT) Encryption (JWT is in JWE format)
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
+import { ProduceJWT } from './produce.js';
 /**
  * The EncryptJWT class is used to build and encrypt Compact JWE formatted JSON Web Tokens.
  *

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

@@ -1,4 +1,4 @@
-import type * as types from '../types';
+import type * as types from '../types.d.ts';
 /** Generic class for JWT producing. */
 export declare class ProduceJWT {
     protected _payload: types.JWTPayload;

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

@@ -1,5 +1,10 @@
-import type * as types from '../types';
-import { ProduceJWT } from './produce';
+/**
+ * JSON Web Token (JWT) Signing (JWT is in JWS format)
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
+import { ProduceJWT } from './produce.js';
 /**
  * The SignJWT class is used to build and sign Compact JWS formatted JSON Web Tokens.
  *

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

@@ -1,5 +1,10 @@
-import type * as types from '../types';
-import { ProduceJWT } from './produce';
+/**
+ * Unsecured (unsigned & unencrypted) JSON Web Tokens (JWT)
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
+import { ProduceJWT } from './produce.js';
 export interface UnsecuredResult<PayloadType = types.JWTPayload> {
     payload: PayloadType & types.JWTPayload;
     header: types.JWSHeaderParameters;

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * 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 {
 }

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * 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.
  *

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * Asymmetric key generation
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
 export interface GenerateKeyPairResult {
     /** The generated Private Key. */
     privateKey: types.CryptoKey;

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * Symmetric key generation
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
 export interface GenerateSecretOptions {
     /** The value to use as {@link !SubtleCrypto.generateKey} `extractable` argument. Default is false. */
     extractable?: boolean;

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * Cryptographic key import functions
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
 export interface KeyImportOptions {
     /**
      * The value to use as {@link !SubtleCrypto.importKey} `extractable` argument. Default is false for

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

@@ -1,3 +1,8 @@
+/**
+ * Base64URL encoding and decoding utilities
+ *
+ * @module
+ */
 /**
  * Utility function to encode a string or {@link !Uint8Array} as a base64url string.
  *

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * JSON Web Token (JWT) Claims Set Decoding (no validation, no signature checking)
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
 /**
  * Decodes a signed JSON Web Token payload. This does not validate the JWT Claims Set types or
  * values. This does not validate the JWS Signature. For a proper Signed JWT Claims Set validation

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * JOSE Protected Header Decoding (JWE, JWS, all serialization syntaxes)
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
 export type ProtectedHeaderParameters = types.JWSHeaderParameters & types.JWEHeaderParameters;
 /**
  * Decodes the Protected Header of a JWE/JWS/JWT token utilizing any JOSE serialization.

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

@@ -1,4 +1,9 @@
-import type * as types from '../types';
+/**
+ * JOSE module errors and error codes
+ *
+ * @module
+ */
+import type * as types from '../types.d.ts';
 /**
  * A generic Error that all other JOSE specific Error subclasses extend.
  *

package/dist/webapi/jwks/remote.js

@@ -9,7 +9,7 @@ function isCloudflareWorkers() {
 let USER_AGENT;
 if (typeof navigator === 'undefined' || !navigator.userAgent?.startsWith?.('Mozilla/5.0 ')) {
     const NAME = 'jose';
-    const VERSION = 'v6.0.0';
+    const VERSION = 'v6.0.2';
     USER_AGENT = `${NAME}/${VERSION}`;
 }
 export const customFetch = Symbol();

package/package.json

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