jose 5.0.1 → 5.1.0

package/dist/browser/jwks/remote.js

@@ -6,6 +6,12 @@ function isCloudflareWorkers() {
         (typeof navigator !== 'undefined' && navigator.userAgent === 'Cloudflare-Workers') ||
         (typeof EdgeRuntime !== 'undefined' && EdgeRuntime === 'vercel'));
 }
+let USER_AGENT;
+if (typeof navigator === 'undefined' || !navigator.userAgent?.startsWith?.('Mozilla/5.0 ')) {
+    const NAME = 'jose';
+    const VERSION = 'v5.1.0';
+    USER_AGENT = `${NAME}/${VERSION}`;
+}
 class RemoteJWKSet extends LocalJWKSet {
     constructor(url, options) {
         super({ keys: [] });
@@ -52,6 +58,11 @@ class RemoteJWKSet extends LocalJWKSet {
         if (this._pendingFetch && isCloudflareWorkers()) {
             this._pendingFetch = undefined;
         }
+        const headers = new Headers(this._options.headers);
+        if (USER_AGENT && !headers.has('User-Agent')) {
+            headers.set('User-Agent', USER_AGENT);
+            this._options.headers = Object.fromEntries(headers.entries());
+        }
         this._pendingFetch || (this._pendingFetch = fetchJwks(this._url, this._timeoutDuration, this._options)
             .then((json) => {
             if (!isJWKSLike(json)) {

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

@@ -9,6 +9,12 @@ function isCloudflareWorkers() {
         (typeof navigator !== 'undefined' && navigator.userAgent === 'Cloudflare-Workers') ||
         (typeof EdgeRuntime !== 'undefined' && EdgeRuntime === 'vercel'));
 }
+let USER_AGENT;
+if (typeof navigator === 'undefined' || !navigator.userAgent?.startsWith?.('Mozilla/5.0 ')) {
+    const NAME = 'jose';
+    const VERSION = 'v5.1.0';
+    USER_AGENT = `${NAME}/${VERSION}`;
+}
 class RemoteJWKSet extends local_js_1.LocalJWKSet {
     _url;
     _timeoutDuration;
@@ -62,6 +68,11 @@ class RemoteJWKSet extends local_js_1.LocalJWKSet {
         if (this._pendingFetch && isCloudflareWorkers()) {
             this._pendingFetch = undefined;
         }
+        const headers = new Headers(this._options.headers);
+        if (USER_AGENT && !headers.has('User-Agent')) {
+            headers.set('User-Agent', USER_AGENT);
+            this._options.headers = Object.fromEntries(headers.entries());
+        }
         this._pendingFetch ||= (0, fetch_jwks_js_1.default)(this._url, this._timeoutDuration, this._options)
             .then((json) => {
             if (!(0, local_js_1.isJWKSLike)(json)) {

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

@@ -6,6 +6,12 @@ function isCloudflareWorkers() {
         (typeof navigator !== 'undefined' && navigator.userAgent === 'Cloudflare-Workers') ||
         (typeof EdgeRuntime !== 'undefined' && EdgeRuntime === 'vercel'));
 }
+let USER_AGENT;
+if (typeof navigator === 'undefined' || !navigator.userAgent?.startsWith?.('Mozilla/5.0 ')) {
+    const NAME = 'jose';
+    const VERSION = 'v5.1.0';
+    USER_AGENT = `${NAME}/${VERSION}`;
+}
 class RemoteJWKSet extends LocalJWKSet {
     _url;
     _timeoutDuration;
@@ -59,6 +65,11 @@ class RemoteJWKSet extends LocalJWKSet {
         if (this._pendingFetch && isCloudflareWorkers()) {
             this._pendingFetch = undefined;
         }
+        const headers = new Headers(this._options.headers);
+        if (USER_AGENT && !headers.has('User-Agent')) {
+            headers.set('User-Agent', USER_AGENT);
+            this._options.headers = Object.fromEntries(headers.entries());
+        }
         this._pendingFetch ||= fetchJwks(this._url, this._timeoutDuration, this._options)
             .then((json) => {
             if (!isJWKSLike(json)) {

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

@@ -9,8 +9,8 @@ export declare class LocalJWKSet<KeyLikeType extends KeyLike = KeyLike> {
     getKey(protectedHeader?: JWSHeaderParameters, token?: FlattenedJWSInput): Promise<KeyLikeType>;
 }
 /**
- * Returns a function that resolves to a key object from a locally stored, or otherwise available,
- * JSON Web Key Set.
+ * 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.
  *
  * It uses the "alg" (JWS Algorithm) Header Parameter to determine the right JWK "kty" (Key Type),
  * then proceeds to match the JWK "kid" (Key ID) with one found in the JWS Header Parameters (if
@@ -21,6 +21,9 @@ export declare class LocalJWKSet<KeyLikeType extends KeyLike = KeyLike> {
  * multiple keys get matched it is possible to opt-in to iterate over the matched keys and attempt
  * verification in an iterative manner.
  *
+ * Note: The function's purpose is to resolve public keys used for verifying signatures and will not
+ * work for public encryption keys.
+ *
  * @param jwks JSON Web Key Set formatted object.
  */
 export declare function createLocalJWKSet<KeyLikeType extends KeyLike = KeyLike>(jwks: JSONWebKeySet): (protectedHeader?: JWSHeaderParameters, token?: FlattenedJWSInput) => Promise<KeyLikeType>;

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

@@ -25,14 +25,18 @@ export interface RemoteJWKSetOptions {
      * used outside of Node.js runtime.
      */
     agent?: any;
-    /** Optional headers to be sent with the HTTP request. */
+    /**
+     * Headers to be sent with the HTTP request. Default is that `User-Agent: jose/v${version}` header
+     * is added unless the runtime is a browser in which adding an explicit headers fetch
+     * configuration would cause an unnecessary CORS preflight request.
+     */
     headers?: Record<string, 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. 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.
+ * Returns a function that resolves a JWS JOSE Header to a public 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. 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.
  *
  * It uses the "alg" (JWS Algorithm) Header Parameter to determine the right JWK "kty" (Key Type),
  * then proceeds to match the JWK "kid" (Key ID) with one found in the JWS Header Parameters (if
@@ -43,6 +47,9 @@ export interface RemoteJWKSetOptions {
  * multiple keys get matched it is possible to opt-in to iterate over the matched keys and attempt
  * verification in an iterative manner.
  *
+ * Note: The function's purpose is to resolve public keys used for verifying signatures and will not
+ * work for public encryption keys.
+ *
  * @param url URL to fetch the JSON Web Key Set from.
  * @param options Options for the remote JSON Web Key Set.
  */

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

@@ -7,4 +7,4 @@ import type { JWTPayload } from '../types';
  *
  * @param jwt JWT token in compact JWS serialization.
  */
-export declare function decodeJwt(jwt: string): JWTPayload;
+export declare function decodeJwt<PayloadType = JWTPayload>(jwt: string): PayloadType & JWTPayload;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jose",
-  "version": "5.0.1",
+  "version": "5.1.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",