@cfworker/jwt 5.1.1 → 5.2.1

package/dist/index.d.ts

@@ -2,5 +2,4 @@ export { decodeJwt } from './decode.js';
 export { getJwks, getKey, importKey } from './jwks.js';
 export { parseJwt } from './parse.js';
 export * from './types.js';
-export { InvalidJwtReasonCode } from './types.js';
 export { verifyJwtSignature } from './verify.js';

package/dist/parse.js

@@ -1,6 +1,7 @@
 import { algs, algToHash } from './algs.js';
 import { decodeJwt } from './decode.js';
 import { getKey } from './jwks.js';
+import { InvalidJwtReasonCode } from './types.js';
 import { verifyJwtSignature } from './verify.js';
 const defaultSkewMs = 60 * 1000;
 export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, skewMs = defaultSkewMs }) {
@@ -12,7 +13,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `Unable to decode JWT.`,
-            reasonCode: 0
+            reasonCode: InvalidJwtReasonCode.Other
         };
     }
     const { typ, alg } = decoded.header;
@@ -20,7 +21,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `Invalid JWT type ${JSON.stringify(typ)}. Expected "JWT".`,
-            reasonCode: 0,
+            reasonCode: InvalidJwtReasonCode.Other,
             decoded
         };
     }
@@ -28,7 +29,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `Invalid JWT algorithm ${JSON.stringify(alg)}. Supported: ${algs}.`,
-            reasonCode: 0,
+            reasonCode: InvalidJwtReasonCode.Other,
             decoded
         };
     }
@@ -37,7 +38,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `Subject claim (sub) is required and must be a string. Received ${JSON.stringify(sub)}.`,
-            reasonCode: 0,
+            reasonCode: InvalidJwtReasonCode.Other,
             decoded
         };
     }
@@ -46,7 +47,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
             return {
                 valid: false,
                 reason: `Invalid JWT audience claim (aud) ${JSON.stringify(aud)}. Expected "${audience}".`,
-                reasonCode: 0,
+                reasonCode: InvalidJwtReasonCode.Other,
                 decoded
             };
         }
@@ -58,7 +59,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
             return {
                 valid: false,
                 reason: `Invalid JWT audience claim array (aud) ${JSON.stringify(aud)}. Does not include "${audience}".`,
-                reasonCode: 0,
+                reasonCode: InvalidJwtReasonCode.Other,
                 decoded
             };
         }
@@ -67,7 +68,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `Invalid JWT audience claim (aud) ${JSON.stringify(aud)}. Expected a string or a non-empty array of strings.`,
-            reasonCode: 0,
+            reasonCode: InvalidJwtReasonCode.Other,
             decoded
         };
     }
@@ -75,7 +76,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `Invalid JWT issuer claim (iss) ${JSON.stringify(decoded.payload.iss)}. Expected ${JSON.stringify(issuer)}.`,
-            reasonCode: 0,
+            reasonCode: InvalidJwtReasonCode.Other,
             decoded
         };
     }
@@ -83,7 +84,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `Invalid JWT expiry date claim (exp) ${JSON.stringify(exp)}. Expected number.`,
-            reasonCode: 0,
+            reasonCode: InvalidJwtReasonCode.Other,
             decoded
         };
     }
@@ -95,7 +96,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `JWT is expired. Expiry date: ${expiryDate}; Current date: ${currentDate};`,
-            reasonCode: 1,
+            reasonCode: InvalidJwtReasonCode.Expired,
             decoded
         };
     }
@@ -104,7 +105,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
             return {
                 valid: false,
                 reason: `Invalid JWT not before date claim (nbf) ${JSON.stringify(nbf)}. Expected number.`,
-                reasonCode: 0,
+                reasonCode: InvalidJwtReasonCode.Other,
                 decoded
             };
         }
@@ -115,7 +116,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
             return {
                 valid: false,
                 reason: `JWT cannot be used prior to not before date claim (nbf). Not before date: ${notBeforeDate}; Current date: ${currentDate};`,
-                reasonCode: 0,
+                reasonCode: InvalidJwtReasonCode.Other,
                 decoded
             };
         }
@@ -125,7 +126,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
             return {
                 valid: false,
                 reason: `Invalid JWT issued at date claim (iat) ${JSON.stringify(iat)}. Expected number.`,
-                reasonCode: 0,
+                reasonCode: InvalidJwtReasonCode.Other,
                 decoded
             };
         }
@@ -136,7 +137,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
             return {
                 valid: false,
                 reason: `JWT issued at date claim (iat) is in the future. Issued at date: ${issuedAtDate}; Current date: ${currentDate};`,
-                reasonCode: 0,
+                reasonCode: InvalidJwtReasonCode.Other,
                 decoded
             };
         }
@@ -149,7 +150,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `Error retrieving public key to verify JWT signature: ${e instanceof Error ? e.message : e}`,
-            reasonCode: 0,
+            reasonCode: InvalidJwtReasonCode.Other,
             decoded
         };
     }
@@ -157,7 +158,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `Unable to resolve public key to verify JWT signature.`,
-            reasonCode: 0,
+            reasonCode: InvalidJwtReasonCode.Other,
             decoded
         };
     }
@@ -169,7 +170,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `Error verifying JWT signature.`,
-            reasonCode: 0,
+            reasonCode: InvalidJwtReasonCode.Other,
             decoded
         };
     }
@@ -177,7 +178,7 @@ export async function parseJwt({ jwt, issuer, audience, resolveKey = getKey, ske
         return {
             valid: false,
             reason: `JWT signature is invalid.`,
-            reasonCode: 0,
+            reasonCode: InvalidJwtReasonCode.Other,
             decoded
         };
     }

package/dist/types.d.ts

@@ -38,7 +38,7 @@ export interface InvalidJwtParseResult {
     reasonCode: InvalidJwtReasonCode;
     decoded?: DecodedJwt;
 }
-export declare const enum InvalidJwtReasonCode {
+export declare enum InvalidJwtReasonCode {
     Other = 0,
     Expired = 1
 }

package/dist/types.js

@@ -1 +1,5 @@
-export {};
+export var InvalidJwtReasonCode;
+(function (InvalidJwtReasonCode) {
+    InvalidJwtReasonCode[InvalidJwtReasonCode["Other"] = 0] = "Other";
+    InvalidJwtReasonCode[InvalidJwtReasonCode["Expired"] = 1] = "Expired";
+})(InvalidJwtReasonCode || (InvalidJwtReasonCode = {}));

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@cfworker/jwt",
-  "version": "5.1.1",
+  "type": "module",
+  "version": "5.2.1",
   "description": "Tiny lib for decoding JWTs and verifying signatures, using native crypto APIs",
   "keywords": [
     "jwt",
@@ -17,7 +18,6 @@
   "files": [
     "dist/**/*",
     "src/**/*",
-    "tsconfig.json",
     "README.md",
     "package.json"
   ],
@@ -44,6 +44,6 @@
     "esbuild": "^0.23.1",
     "mocha": "^10.7.3",
     "typescript": "^5.5.4",
-    "wrangler": "^3.72.0"
+    "wrangler": "^3.72.1"
   }
 }

package/src/algs.ts

@@ -4,4 +4,4 @@ export const algToHash: Record<string, string> = {
   RS512: 'SHA-512'
 };
 
-export const algs = Object.keys(algToHash);
+export const algs: string[] = Object.keys(algToHash);

package/src/index.ts

@@ -2,5 +2,4 @@ export { decodeJwt } from './decode.js';
 export { getJwks, getKey, importKey } from './jwks.js';
 export { parseJwt } from './parse.js';
 export * from './types.js';
-export { InvalidJwtReasonCode } from './types.js';
 export { verifyJwtSignature } from './verify.js';

package/src/jwks.ts

@@ -35,7 +35,7 @@ const importedKeys: Record<string, Record<string, CryptoKey>> = {};
  * @param iss The issuer. Serves as the first-level cache key.
  * @param jwks The JsonWebKeyset to import.
  */
-export async function importKey(iss: string, jwk: JsonWebKey) {
+export async function importKey(iss: string, jwk: JsonWebKey): Promise<void> {
   if (jwk.kty !== 'RSA') {
     throw new Error(
       `Unsupported jwk key type (kty) "${

package/src/types.ts

@@ -52,7 +52,7 @@ export interface InvalidJwtParseResult {
   decoded?: DecodedJwt;
 }
 
-export const enum InvalidJwtReasonCode {
+export enum InvalidJwtReasonCode {
   Other = 0,
   Expired = 1
 }

package/src/verify.ts

@@ -4,7 +4,10 @@ import { DecodedJwt } from './types.js';
  * Verify the JWT's signature.
  * @param {DecodedJwt} decoded
  */
-export async function verifyJwtSignature(decoded: DecodedJwt, key: CryptoKey) {
+export async function verifyJwtSignature(
+  decoded: DecodedJwt,
+  key: CryptoKey
+): Promise<boolean> {
   const encoder = new TextEncoder();
   const data = encoder.encode(`${decoded.raw.header}.${decoded.raw.payload}`);
 

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "extends": "../../tsconfig-base",
-  "compilerOptions": {
-    "target": "ESNext",
-    "lib": ["ESNext", "WebWorker", "Webworker.Iterable"],
-    "outDir": "dist",
-    "rootDir": "./src"
-  },
-  "include": ["src"],
-  "references": []
-}