jose 4.10.0 → 4.10.1

package/README.md

@@ -96,31 +96,6 @@ import * as jose from 'https://deno.land/x/jose/index.ts'
 | [v4.x](https://github.com/panva/jose/tree/v4.x) | ✅ | ✅ | ✅ |
 | [v3.x](https://github.com/panva/jose/tree/v3.x), [v2.x](https://github.com/panva/jose/tree/v2.x), [v1.x](https://github.com/panva/jose/tree/v1.x) | ✅ | ❌ | ❌ |
 
-#### Semver?
-
-**Yes.** All module's public API is subject to [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html).
-
-#### How is it different from [`jws`](https://github.com/brianloveswords/node-jws), [`jwa`](https://github.com/brianloveswords/node-jwa) or [`jsonwebtoken`](https://github.com/auth0/node-jsonwebtoken)?
-
-- it supports Browser, Deno, Cloudflare Workers, and other Web-interoperable runtimes
-- it supports encrypted JWTs (i.e. in JWE format)
-- supports secp256k1, Ed25519, Ed448, X25519, and X448
-- it supports JWK Key Format for all four key types (oct, RSA, EC and OKP)
-- it is exclusively using native platform Key object representations (CryptoKey and KeyObject)
-- there is JSON Web Encryption support
-- it supports the General and Flattened JSON Serialization Syntaxes
-- it supports the "crit" member validations to make sure extensions are handled correctly
-
-#### How is it different from [`node-jose`](https://github.com/cisco/node-jose)?
-
-`node-jose` is built to work in any javascript runtime, to be able to do that it packs a lot of
-polyfills and javascript implementation code in the form of
-[`node-forge`](https://github.com/digitalbazaar/forge), this significantly increases the footprint
-of the modules with dependencies that either aren't ever used or have native implementation available
-in the runtime already, those are often times faster and more reliable.
-
-- supports secp256k1, Ed25519, Ed448, X25519, and X448
-
 #### Uint8Array?!
 
 - Whenever `Uint8Array` is a valid input, so is [`Buffer`](https://nodejs.org/api/buffer.html#buffer_buffer) since buffers are instances of Uint8Array.

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

@@ -1,7 +1,6 @@
 import type { JWK } from '../types';
 /**
- * Calculates a base64url-encoded JSON Web Key (JWK) Thumbprint as per
- * [RFC7638](https://www.rfc-editor.org/rfc/rfc7638).
+ * Calculates a base64url-encoded JSON Web Key (JWK) Thumbprint
  *
  * @example Usage
  *
@@ -18,11 +17,13 @@ import type { JWK } from '../types';
  * ```
  *
  * @param jwk JSON Web Key.
- * @param digestAlgorithm Digest Algorithm to use for calculating the thumbprint. Default is "sha256".
+ * @param digestAlgorithm Digest Algorithm to use for calculating the thumbprint. Default is
+ *   "sha256".
+ * @see [RFC7638](https://www.rfc-editor.org/rfc/rfc7638)
  */
 export declare function calculateJwkThumbprint(jwk: JWK, digestAlgorithm?: 'sha256' | 'sha384' | 'sha512'): Promise<string>;
 /**
- * Calculates a JSON Web Key (JWK) Thumbprint URI as per [RFC9278](https://www.rfc-editor.org/rfc/rfc9278).
+ * Calculates a JSON Web Key (JWK) Thumbprint URI
  *
  * @example Usage
  *
@@ -39,6 +40,8 @@ export declare function calculateJwkThumbprint(jwk: JWK, digestAlgorithm?: 'sha2
  * ```
  *
  * @param jwk JSON Web Key.
- * @param digestAlgorithm Digest Algorithm to use for calculating the thumbprint. Default is "sha256".
+ * @param digestAlgorithm Digest Algorithm to use for calculating the thumbprint. Default is
+ *   "sha256".
+ * @see [RFC9278](https://www.rfc-editor.org/rfc/rfc9278)
  */
 export declare function calculateJwkThumbprintUri(jwk: JWK, digestAlgorithm?: 'sha256' | 'sha384' | 'sha512'): Promise<string>;

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

@@ -11,7 +11,10 @@ export interface RemoteJWKSetOptions {
      * successful fetch. Default is 30000 (30 seconds).
      */
     cooldownDuration?: number;
-    /** Maximum time (in milliseconds) between successful HTTP requests. Default is 600000 (10 minutes). */
+    /**
+     * Maximum time (in milliseconds) between successful HTTP requests. Default is 600000 (10
+     * minutes).
+     */
     cacheMaxAge?: number | typeof Infinity;
     /**
      * An instance of [http.Agent](https://nodejs.org/api/http.html#class-httpagent) or
@@ -25,14 +28,12 @@ export interface RemoteJWKSetOptions {
     /** Optional headers to be sent with the HTTP request. */
     headers?: Record<string, string>;
 }
-interface URL {
-    href: string;
-}
 /**
  * Returns a function that resolves to a key object downloaded from a remote endpoint returning a
  * JSON Web Key Set, that is, for example, an OAuth 2.0 or OIDC jwks_uri. Only a single public key
  * must match the selection process. The JSON Web Key Set is fetched when no key matches the
- * selection process but only as frequently as the `cooldownDuration` option allows, to prevent abuse.
+ * selection process but only as frequently as the `cooldownDuration` option allows, to prevent
+ * abuse.
  *
  * @example Usage
  *
@@ -51,4 +52,3 @@ interface URL {
  * @param options Options for the remote JSON Web Key Set.
  */
 export declare function createRemoteJWKSet(url: URL, options?: RemoteJWKSetOptions): GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput>;
-export {};

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

@@ -47,7 +47,8 @@ export declare class ProduceJWT {
     /**
      * Set "iat" (Issued At) Claim.
      *
-     * @param input "iat" (Issued At) Claim value to set on the JWT Claims Set. Default is current timestamp.
+     * @param input "iat" (Issued At) Claim value to set on the JWT Claims Set. Default is current
+     *   timestamp.
      */
     setIssuedAt(input?: number): this;
 }

package/dist/types/types.d.ts

@@ -368,7 +368,7 @@ export interface CritOption {
    * for those is either `true` or `false`. `true` when the Header Parameter MUST be integrity
    * protected, `false` when it's irrelevant.
    *
-   * This makes the "Extension Header Parameter "${parameter}" is not recognized" error go away.
+   * This makes the "Extension Header Parameter "..." is not recognized" error go away.
    *
    * Use this when a given JWS/JWT/JWE profile requires the use of proprietary non-registered "crit"
    * (Critical) Header Parameters. This will only make sure the Header Parameter is syntactically
@@ -378,7 +378,8 @@ export interface CritOption {
    * the operation succeeds.
    *
    * The JWS extension Header Parameter `b64` is always recognized and processed properly. No other
-   * registered Header Parameters that need this kind of default built-in treatment are currently available.
+   * registered Header Parameters that need this kind of default built-in treatment are currently
+   * available.
    */
   crit?: {
     [propName: string]: boolean
@@ -460,7 +461,8 @@ export interface JWTClaimVerificationOptions {
 export interface VerifyOptions extends CritOption {
   /**
    * A list of accepted JWS "alg" (Algorithm) Header Parameter values. By default all "alg"
-   * (Algorithm) values applicable for the used key/secret are allowed. Note: "none" is never accepted.
+   * (Algorithm) values applicable for the used key/secret are allowed. Note: "none" is never
+   * accepted.
    */
   algorithms?: string[]
 }
@@ -470,25 +472,49 @@ export interface SignOptions extends CritOption {}
 
 /** Recognized JWT Claims Set members, any other members may also be present. */
 export interface JWTPayload {
-  /** JWT Issuer - [RFC7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1). */
+  /**
+   * JWT Issuer
+   *
+   * @see [RFC7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
+   */
   iss?: string
 
-  /** JWT Subject - [RFC7519#section-4.1.2](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.2). */
+  /**
+   * JWT Subject
+   *
+   * @see [RFC7519#section-4.1.2](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.2)
+   */
   sub?: string
 
   /** JWT Audience [RFC7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3). */
   aud?: string | string[]
 
-  /** JWT ID - [RFC7519#section-4.1.7](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.7). */
+  /**
+   * JWT ID
+   *
+   * @see [RFC7519#section-4.1.7](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.7)
+   */
   jti?: string
 
-  /** JWT Not Before - [RFC7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5). */
+  /**
+   * JWT Not Before
+   *
+   * @see [RFC7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
+   */
   nbf?: number
 
-  /** JWT Expiration Time - [RFC7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4). */
+  /**
+   * JWT Expiration Time
+   *
+   * @see [RFC7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
+   */
   exp?: number
 
-  /** JWT Issued At - [RFC7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6). */
+  /**
+   * JWT Issued At
+   *
+   * @see [RFC7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
+   */
   iat?: number
 
   /** Any other JWT Claim Set member. */

package/package.json

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