@carecard/jwt-read 3.0.1 → 3.0.3

package/index.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Utility functions for reading and verifying JWTs.
+ */
+
+/**
+ * Verifies a JWT from the 'Authorization: Bearer <token>' header and extracts it into req.jwt.
+ * Throws an error if invalid.
+ */
+export function verifyJwt(req: any, publicKey: string, customErrorFunction?: () => void): Promise<any>;
+
+/**
+ * Verifies a JWT from a custom header and extracts it into req.jwt.
+ * Throws an error if invalid.
+ */
+export function verifyWebToken(req: any, publicKey: string, headerName: string, customErrorFunction?: () => void): Promise<any>;
+
+/**
+ * Verifies a JWT from the 'Authorization: Bearer <token>' header and extracts it into req.jwt.
+ * Returns false instead of throwing if invalid.
+ */
+export function verifyJwtNoThrow(req: any, publicKey: string): Promise<boolean>;
+
+/**
+ * Verifies a JWT from a custom header and extracts it into req.jwt.
+ * Returns false instead of throwing if invalid.
+ */
+export function verifyWebTokenNoThrow(req: any, publicKey: string, headerName: string): Promise<boolean>;
+
+/**
+ * Verifies a visitor token from the 'x-visitor-token' header and extracts it into req.visitor.
+ * Returns false instead of throwing if invalid.
+ */
+export function verifyVisitorNoThrow(req: any, publicKey: string): Promise<boolean>;
+
+/**
+ * Returns the client_id from the extracted JWT in req.jwt.
+ */
+export function jwtClientId(req: any): string | undefined;
+
+/**
+ * Returns the client_id from the extracted visitor token in req.visitor.
+ */
+export function visitorClientId(req: any): string | undefined;
+
+/**
+ * Checks if the extracted JWT in req.jwt has expired.
+ */
+export function isJwtExpired(req: any, jwtValiditySeconds?: number): boolean;
+
+/**
+ * Returns the age of the extracted JWT in seconds.
+ */
+export function jwtAgeInSeconds(req: any): number;
+
+/**
+ * Verifies the JWT and checks if the user has the required role.
+ */
+export function verifyJwtAndRole(req: any, publicKey: string, userRole: string, customErrorFunction?: () => void): Promise<any>;
+
+/**
+ * Throws a Used_Token error.
+ */
+export function throwUsedTokenError(): never;
+
+/**
+ * Checks if the user in the extracted JWT has the specified role.
+ */
+export function doesJwtUserHasRole(req: any, userRole: string): boolean;
+
+/**
+ * Gets the full name of a role from its code (e.g., 'ad' -> 'admin').
+ */
+export function getNameOfRole(roleCode: string): string;
+
+/**
+ * Gets the code of a role from its name (e.g., 'admin' -> 'ad').
+ */
+export function getCodeOfRole(roleName: string): string;

package/lib/jwtLib.js

@@ -44,6 +44,12 @@ function isJwtExpired( req, jwtValiditySeconds ) {
         req = undefined;
     }
 
+    const jwtObj = req?.jwt || this;
+
+    if ( jwtObj?.payload?.exp ) {
+        return ( Math.floor( Date.now() / 1000 ) ) >= jwtObj.payload.exp;
+    }
+
     if ( jwtValiditySeconds && typeof jwtValiditySeconds === "number" ) {
         return ( parseInt( jwtValiditySeconds ) ) < jwtAgeInSeconds.call( this, req );
     } else {
@@ -75,12 +81,12 @@ function jwtAgeInSeconds( req ) {
 
 async function validateAndExtractJwtObject( req, publicKey, customErrorFunction ) {
 
-    const jwtString = await _validateJwt( req, customErrorFunction );
+    const jwtString = _validateJwt( req, customErrorFunction );
 
-    const isJwtSignatureValid = await _isJwtSignatureValid( jwtString, publicKey, customErrorFunction );
+    const isJwtSignatureValid = jwtUtilAuth.verifyJwtSignature( jwtString, publicKey );
 
     if ( jwtString && isJwtSignatureValid ) {
-        await _extractJwtObject( req, jwtString, customErrorFunction );
+        _extractJwtObject( req, jwtString, customErrorFunction );
     } else {
         req[ "jwt" ] = null;
         throwError( customErrorFunction );
@@ -91,12 +97,12 @@ async function validateAndExtractJwtObject( req, publicKey, customErrorFunction
 
 async function validateAndExtractWebToken( req, publicKey, headerName, customErrorFunction ) {
 
-    const webTokenString = await _validateWebToken( req, headerName, customErrorFunction );
+    const webTokenString = _validateWebToken( req, headerName, customErrorFunction );
 
-    const isJwtSignatureValid = await _isJwtSignatureValid( webTokenString, publicKey, customErrorFunction );
+    const isJwtSignatureValid = jwtUtilAuth.verifyJwtSignature( webTokenString, publicKey );
 
     if ( webTokenString && isJwtSignatureValid ) {
-        await _extractJwtObject( req, webTokenString, customErrorFunction );
+        _extractJwtObject( req, webTokenString, customErrorFunction );
     } else {
         req[ "jwt" ] = null;
         throwError( customErrorFunction );
@@ -109,12 +115,12 @@ async function validateAndExtractJwtObjectNoThrow( req, publicKey ) {
 
     try {
 
-        const jwtString = await _validateJwtNoThrow( req );
+        const jwtString = _validateJwtNoThrow( req );
 
-        const isJwtSignatureValid = await _isJwtSignatureValidNoThrow( jwtString, publicKey );
+        const isJwtSignatureValid = jwtUtilAuth.verifyJwtSignature( jwtString, publicKey );
 
         if ( jwtString && isJwtSignatureValid ) {
-            await _extractJwtObjectNoThrow( req, jwtString );
+            _extractJwtObjectNoThrow( req, jwtString );
         } else {
             req[ "jwt" ] = null;
         }
@@ -134,10 +140,10 @@ async function validateAndExtractWebTokenObjectNoThrow( req, publicKey, headerNa
 
         const jwtString = _validateWebTokenNoThrow( req, headerName );
 
-        const isJwtSignatureValid = await _isJwtSignatureValidNoThrow( jwtString, publicKey );
+        const isJwtSignatureValid = jwtUtilAuth.verifyJwtSignature( jwtString, publicKey );
 
         if ( jwtString && isJwtSignatureValid ) {
-            await _extractJwtObjectNoThrow( req, jwtString );
+            _extractJwtObjectNoThrow( req, jwtString );
         } else {
             req[ "jwt" ] = null;
         }
@@ -155,12 +161,12 @@ async function validateAndExtractVisitorObjectNoThrow( req, publicKey ) {
 
     try {
 
-        const jwtString = await _validateVisitorNoThrow( req );
+        const jwtString = _validateVisitorNoThrow( req );
 
-        const isJwtSignatureValid = await _isJwtSignatureValidNoThrow( jwtString, publicKey );
+        const isJwtSignatureValid = jwtUtilAuth.verifyJwtSignature( jwtString, publicKey );
 
         if ( jwtString && isJwtSignatureValid ) {
-            await _extractVisitorObjectNoThrow( req, jwtString );
+            _extractVisitorObjectNoThrow( req, jwtString );
         } else {
             req[ "visitor" ] = null;
         }
@@ -239,7 +245,7 @@ function _isLoginRequired( hasRequiredRole, customErrorFunction ) {
 
 }
 
-async function _extractJwtObject( req, jwt, customErrorFunction ) {
+function _extractJwtObject( req, jwt, customErrorFunction ) {
     if ( jwt && typeof jwt === "string" ) {
         const jwtObj = jwtUtilAuth.getHeaderPayloadFromJwt( jwt );
         _attachJwtMethods( jwtObj );
@@ -249,7 +255,7 @@ async function _extractJwtObject( req, jwt, customErrorFunction ) {
     }
 }
 
-async function _extractJwtObjectNoThrow( req, jwt ) {
+function _extractJwtObjectNoThrow( req, jwt ) {
     if ( jwt && typeof jwt === "string" ) {
         const jwtObj = jwtUtilAuth.getHeaderPayloadFromJwt( jwt );
         _attachJwtMethods( jwtObj );
@@ -259,7 +265,7 @@ async function _extractJwtObjectNoThrow( req, jwt ) {
     }
 }
 
-async function _extractVisitorObjectNoThrow( req, jwt ) {
+function _extractVisitorObjectNoThrow( req, jwt ) {
     if ( jwt && typeof jwt === "string" ) {
         const visitorObj = jwtUtilAuth.getHeaderPayloadFromJwt( jwt );
         _attachVisitorMethods( visitorObj );
@@ -306,7 +312,7 @@ async function _isJwtSignatureValidNoThrow( jwt, publicKey ) {
     }
 }
 
-async function _validateJwt( req, customErrorFunction ) {
+function _validateJwt( req, customErrorFunction ) {
 
     // Get from http header.
     let jwtRaw = req.get( "Authorization" );
@@ -322,7 +328,7 @@ async function _validateJwt( req, customErrorFunction ) {
     }
 }
 
-async function _validateWebToken( req, headerName, customErrorFunction ) {
+function _validateWebToken( req, headerName, customErrorFunction ) {
 
     // Get from http header.
     let jwtRaw = req.get( headerName );

package/lib/jwtRoles.js

@@ -7,14 +7,14 @@ function getNameOfRoleFromCode( roleCode ) {
     const codesToCategory = {
         "ad": "admin",
         "su": "super_admin",
-    }
+    };
     return codesToCategory[ roleCode ] || "";
 }
 
-function getCodeFromNameOfRole( roleCode ) {
-    const codesToCategory = {
+function getCodeFromNameOfRole( roleName ) {
+    const namesToCode = {
         "admin": "ad",
         "super_admin": "su",
-    }
-    return codesToCategory[ roleCode ] || "";
+    };
+    return namesToCode[ roleName ] || "";
 }

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@carecard/jwt-read",
-  "version": "3.0.1",
+  "version": "3.0.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/CareCard-ca/pkg-jwt-read.git"
   },
   "description": "Jwt read functions",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
-    "test": "export NODE_ENV=test && mocha --watch --recursive"
+    "test": "export NODE_ENV=test && mocha --watch --recursive",
+    "test:types": "tsc --noEmit && mocha -r ts-node/register test/types.test.ts"
   },
   "keywords": [
     "auth",
@@ -18,11 +20,15 @@
   "author": "CareCard team",
   "license": "ISC",
   "devDependencies": {
-    "mocha": "11.7.5"
+    "@types/mocha": "10.0.10",
+    "@types/node": "25.5.0",
+    "mocha": "11.7.5",
+    "ts-node": "10.9.2",
+    "typescript": "5.9.3"
   },
   "dependencies": {
-    "@carecard/auth-util": "3.0.1",
-    "@carecard/common-util": "2.0.2",
-    "@carecard/validate": "2.2.12"
+    "@carecard/auth-util": "3.0.3",
+    "@carecard/common-util": "3.0.3",
+    "@carecard/validate": "3.0.3"
   }
 }