jose 6.0.1 → 6.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,9 @@
1
+ /**
2
+ * JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other
3
+ * Web-interoperable runtimes
4
+ *
5
+ * @module jose
6
+ */
1
7
  export { compactDecrypt } from './jwe/compact/decrypt.js';
2
8
  export type { CompactDecryptGetKey } from './jwe/compact/decrypt.js';
3
9
  export { flattenedDecrypt } from './jwe/flattened/decrypt.js';
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Decrypting JSON Web Encryption (JWE) in Compact Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  /**
3
8
  * Interface for Compact JWE Decryption dynamic key resolution. No token components have been
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Encrypting JSON Web Encryption (JWE) in Compact Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  /**
3
8
  * The CompactEncrypt class is used to build and encrypt Compact JWE strings.
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Decrypting JSON Web Encryption (JWE) in Flattened JSON Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  /**
3
8
  * Interface for Flattened JWE Decryption dynamic key resolution. No token components have been
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Encrypting JSON Web Encryption (JWE) in Flattened JSON Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  /**
3
8
  * The FlattenedEncrypt class is used to build and encrypt Flattened JWE objects.
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Decrypting JSON Web Encryption (JWE) in General JSON Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  /**
3
8
  * Interface for General JWE Decryption dynamic key resolution. No token components have been
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Encrypting JSON Web Encryption (JWE) in General JSON Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  export interface Recipient {
3
8
  /**
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Verification using a JWK Embedded in a JWS Header
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  /**
3
8
  * EmbeddedJWK is an implementation of a GetKeyFunction intended to be used with the JWS/JWT verify
@@ -1,3 +1,8 @@
1
+ /**
2
+ * JSON Web Key Thumbprint and JSON Web Key Thumbprint URI
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  /**
3
8
  * Calculates a base64url-encoded JSON Web Key (JWK) Thumbprint
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Verification using a JSON Web Key Set (JWKS) available locally
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  /**
3
8
  * Returns a function that resolves a JWS JOSE Header to a public key object from a locally stored,
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Verification using a JSON Web Key Set (JWKS) available on an HTTP(S) URL
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  /**
3
8
  * When passed to {@link jwks/remote.createRemoteJWKSet createRemoteJWKSet} this allows the resolver
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Signing JSON Web Signature (JWS) in Compact Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  /**
3
8
  * The CompactSign class is used to build and sign Compact JWS strings.
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Verifying JSON Web Signature (JWS) in Compact Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  /**
3
8
  * Interface for Compact JWS Verification dynamic key resolution. No token components have been
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Signing JSON Web Signature (JWS) in Flattened JSON Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  /**
3
8
  * The FlattenedSign class is used to build and sign Flattened JWS objects.
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Verifying JSON Web Signature (JWS) in Flattened JSON Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  /**
3
8
  * Interface for Flattened JWS Verification dynamic key resolution. No token components have been
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Signing JSON Web Signature (JWS) in General JSON Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  export interface Signature {
3
8
  /**
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Verifying JSON Web Signature (JWS) in General JSON Serialization
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../../types.d.ts';
2
7
  /**
3
8
  * Interface for General JWS Verification dynamic key resolution. No token components have been
@@ -1,3 +1,8 @@
1
+ /**
2
+ * JSON Web Token (JWT) Decryption (JWT is in JWE format)
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  /** Combination of JWE Decryption options and JWT Claims Set verification options. */
3
8
  export interface JWTDecryptOptions extends types.DecryptOptions, types.JWTClaimVerificationOptions {
@@ -1,3 +1,8 @@
1
+ /**
2
+ * JSON Web Token (JWT) Encryption (JWT is in JWE format)
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  import { ProduceJWT } from './produce.js';
3
8
  /**
@@ -1,3 +1,8 @@
1
+ /**
2
+ * JSON Web Token (JWT) Signing (JWT is in JWS format)
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  import { ProduceJWT } from './produce.js';
3
8
  /**
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Unsecured (unsigned & unencrypted) JSON Web Tokens (JWT)
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  import { ProduceJWT } from './produce.js';
3
8
  export interface UnsecuredResult<PayloadType = types.JWTPayload> {
@@ -1,3 +1,8 @@
1
+ /**
2
+ * JSON Web Token (JWT) Verification (JWT is in JWS format)
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  /** Combination of JWS Verification options and JWT Claims Set verification options. */
3
8
  export interface JWTVerifyOptions extends types.VerifyOptions, types.JWTClaimVerificationOptions {
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Cryptographic key export functions
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  /**
3
8
  * Exports a public {@link !CryptoKey} or {@link !KeyObject} to a PEM-encoded SPKI string format.
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Asymmetric key generation
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  export interface GenerateKeyPairResult {
3
8
  /** The generated Private Key. */
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Symmetric key generation
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  export interface GenerateSecretOptions {
3
8
  /** The value to use as {@link !SubtleCrypto.generateKey} `extractable` argument. Default is false. */
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Cryptographic key import functions
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  export interface KeyImportOptions {
3
8
  /**
@@ -1,3 +1,8 @@
1
+ /**
2
+ * Base64URL encoding and decoding utilities
3
+ *
4
+ * @module
5
+ */
1
6
  /**
2
7
  * Utility function to encode a string or {@link !Uint8Array} as a base64url string.
3
8
  *
@@ -1,3 +1,8 @@
1
+ /**
2
+ * JSON Web Token (JWT) Claims Set Decoding (no validation, no signature checking)
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  /**
3
8
  * Decodes a signed JSON Web Token payload. This does not validate the JWT Claims Set types or
@@ -1,3 +1,8 @@
1
+ /**
2
+ * JOSE Protected Header Decoding (JWE, JWS, all serialization syntaxes)
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  export type ProtectedHeaderParameters = types.JWSHeaderParameters & types.JWEHeaderParameters;
3
8
  /**
@@ -1,3 +1,8 @@
1
+ /**
2
+ * JOSE module errors and error codes
3
+ *
4
+ * @module
5
+ */
1
6
  import type * as types from '../types.d.ts';
2
7
  /**
3
8
  * A generic Error that all other JOSE specific Error subclasses extend.
@@ -9,7 +9,7 @@ function isCloudflareWorkers() {
9
9
  let USER_AGENT;
10
10
  if (typeof navigator === 'undefined' || !navigator.userAgent?.startsWith?.('Mozilla/5.0 ')) {
11
11
  const NAME = 'jose';
12
- const VERSION = 'v6.0.1';
12
+ const VERSION = 'v6.0.2';
13
13
  USER_AGENT = `${NAME}/${VERSION}`;
14
14
  }
15
15
  export const customFetch = Symbol();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jose",
3
- "version": "6.0.1",
3
+ "version": "6.0.2",
4
4
  "description": "JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other Web-interoperable runtimes",
5
5
  "keywords": [
6
6
  "browser",