@carecard/jwt-read 2.0.1 → 3.0.2

package/index.js

@@ -11,6 +11,7 @@ module.exports = {
     jwtClientId: jwtLib.jwtClientId,
     visitorClientId: jwtLib.visitorClientId,
     isJwtExpired: jwtLib.isJwtExpired,
+    jwtAgeInSeconds: jwtLib.jwtAgeInSeconds,
     verifyJwtAndRole: jwtLib.verifyJwtAndRole,
     throwUsedTokenError: jwtLib.throwUsedTokenError,
     doesJwtUserHasRole: jwtLib.doesJwtUserHasRole,

package/lib/jwtLib.js

@@ -6,21 +6,26 @@ const {
 } = require( "@carecard/common-util" ).error;
 
 function jwtClientId( req ) {
-
-    return req?.jwt?.payload?.client_id;
-
+    const jwtObj = req?.jwt || this;
+    return jwtObj?.payload?.client_id;
 }
 
 function visitorClientId( req ) {
-
-    return req?.visitor?.payload?.client_id;
-
+    const visitorObj = req?.visitor || this;
+    return visitorObj?.payload?.client_id;
 }
 
 function doesJwtUserHasRole( req, userRole ) {
+    // Check if called as req.jwt.doesJwtUserHasRole(userRole) or doesJwtUserHasRole(role)
+    if ( arguments.length === 1 && typeof req === 'string' ) {
+        userRole = req;
+        req = undefined;
+    }
+
+    const jwtObj = req?.jwt || this;
 
     if ( userRole && typeof userRole === "string" ) {
-        return req?.jwt?.payload?.roles?.includes( userRole );
+        return jwtObj?.payload?.roles?.includes( userRole );
     } else {
         throwNotAuthorizedError();
     }
@@ -33,38 +38,55 @@ function throwError( customErrorFunction ) {
 }
 
 function isJwtExpired( req, jwtValiditySeconds ) {
+    // Check if called as req.jwt.isJwtExpired(seconds) or isJwtExpired(seconds)
+    if ( arguments.length === 1 && typeof req === 'number' ) {
+        jwtValiditySeconds = req;
+        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 ) * 1000 ) < jwtAgeInMilliseconds( req );
+        return ( parseInt( jwtValiditySeconds ) ) < jwtAgeInSeconds.call( this, req );
     } else {
         return true;
     }
 
 }
 
-function jwtAgeInMilliseconds( req ) {
+function jwtAgeInSeconds( req ) {
+    const jwtObj = req?.jwt || this;
+
+    if ( jwtObj?.payload?.iat ) {
 
-    if ( req?.jwt?.payload?.iat ) {
+        let iat = jwtObj.payload.iat;
+        if ( iat > 1000000000000 ) {
+            iat = Math.floor( iat / 1000 );
+        }
 
-        req.jwt[ "age" ] = Date.now() - req.jwt.payload.iat;
-        return req.jwt.age;
+        jwtObj[ "age" ] = Math.floor( Date.now() / 1000 ) - iat;
+        return jwtObj.age;
 
     } else {
 
-        req.jwt[ "age" ] = Infinity
-        return req.jwt.age;
+        jwtObj[ "age" ] = Infinity
+        return jwtObj.age;
 
     }
 }
 
 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 );
@@ -75,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 );
@@ -93,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;
         }
@@ -118,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;
         }
@@ -139,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;
         }
@@ -163,7 +185,7 @@ function verifyJwtAndRole( role, publicKey, customErrorFunction ) {
         await validateAndExtractJwtObject( req, publicKey, customErrorFunction )
             .then( req => doesJwtUserHasRole( req, role ) )
             .then( isRoleExist => _isLoginRequired( isRoleExist, customErrorFunction ) )
-            .then( next )
+            .then( () => next() )
             .catch( next );
     }
 }
@@ -223,30 +245,55 @@ function _isLoginRequired( hasRequiredRole, customErrorFunction ) {
 
 }
 
-async function _extractJwtObject( req, jwt, customErrorFunction ) {
+function _extractJwtObject( req, jwt, customErrorFunction ) {
     if ( jwt && typeof jwt === "string" ) {
-        req[ "jwt" ] = jwtUtilAuth.getHeaderPayloadFromJwt( jwt );
+        const jwtObj = jwtUtilAuth.getHeaderPayloadFromJwt( jwt );
+        _attachJwtMethods( jwtObj );
+        req[ "jwt" ] = jwtObj;
     } else {
         throwError( customErrorFunction );
     }
 }
 
-async function _extractJwtObjectNoThrow( req, jwt ) {
+function _extractJwtObjectNoThrow( req, jwt ) {
     if ( jwt && typeof jwt === "string" ) {
-        req[ "jwt" ] = jwtUtilAuth.getHeaderPayloadFromJwt( jwt );
+        const jwtObj = jwtUtilAuth.getHeaderPayloadFromJwt( jwt );
+        _attachJwtMethods( jwtObj );
+        req[ "jwt" ] = jwtObj;
     } else {
         req[ "jwt" ] = null;
     }
 }
 
-async function _extractVisitorObjectNoThrow( req, jwt ) {
+function _extractVisitorObjectNoThrow( req, jwt ) {
     if ( jwt && typeof jwt === "string" ) {
-        req[ "visitor" ] = jwtUtilAuth.getHeaderPayloadFromJwt( jwt );
+        const visitorObj = jwtUtilAuth.getHeaderPayloadFromJwt( jwt );
+        _attachVisitorMethods( visitorObj );
+        req[ "visitor" ] = visitorObj;
     } else {
         req[ "visitor" ] = null;
     }
 }
 
+function _attachJwtMethods( jwtObj ) {
+    if ( jwtObj ) {
+        Object.defineProperties( jwtObj, {
+            jwtClientId: { value: jwtClientId, enumerable: false },
+            doesJwtUserHasRole: { value: doesJwtUserHasRole, enumerable: false },
+            isJwtExpired: { value: isJwtExpired, enumerable: false },
+            jwtAgeInSeconds: { value: jwtAgeInSeconds, enumerable: false }
+        } );
+    }
+}
+
+function _attachVisitorMethods( visitorObj ) {
+    if ( visitorObj ) {
+        Object.defineProperties( visitorObj, {
+            visitorClientId: { value: visitorClientId, enumerable: false }
+        } );
+    }
+}
+
 async function _isJwtSignatureValid( jwt, publicKey, customErrorFunction ) {
 
     if ( jwt && typeof jwt === "string" ) {
@@ -265,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" );
@@ -281,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 );
@@ -418,7 +465,7 @@ module.exports = {
     _extractJwtObject,
     _extractJwtObjectNoThrow,
     validateAndExtractJwtObject,
-    jwtAgeInMilliseconds,
+    jwtAgeInSeconds,
     isJwtExpired,
     doesJwtUserHasRole,
     jwtClientId,

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,6 +1,6 @@
 {
   "name": "@carecard/jwt-read",
-  "version": "2.0.1",
+  "version": "3.0.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/CareCard-ca/pkg-jwt-read.git"
@@ -18,11 +18,11 @@
   "author": "CareCard team",
   "license": "ISC",
   "devDependencies": {
-    "mocha": "11.7.4"
+    "mocha": "11.7.5"
   },
   "dependencies": {
-    "@carecard/auth-util": "2.0.1",
-    "@carecard/common-util": "2.0.1",
-    "@carecard/validate": "2.0.1"
+    "@carecard/auth-util": "3.0.2",
+    "@carecard/common-util": "2.0.2",
+    "@carecard/validate": "2.2.12"
   }
 }

package/coverage/clover.xml

@@ -1,206 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1766557826816" clover="3.2.0">
-  <project timestamp="1766557826816" name="All files">
-    <metrics statements="191" coveredstatements="158" conditionals="114" coveredconditionals="84" methods="48" coveredmethods="47" elements="353" coveredelements="289" complexity="0" loc="191" ncloc="191" packages="1" files="3" classes="3"/>
-    <file name="index.ts" path="/Users/pankajpriscilla/SO_CareCardCa/pkg-jwt-read/src/index.ts">
-      <metrics statements="3" coveredstatements="3" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
-      <line num="1" count="2" type="stmt"/>
-      <line num="2" count="2" type="stmt"/>
-      <line num="3" count="2" type="stmt"/>
-    </file>
-    <file name="jwtLib.ts" path="/Users/pankajpriscilla/SO_CareCardCa/pkg-jwt-read/src/jwtLib.ts">
-      <metrics statements="182" coveredstatements="149" conditionals="110" coveredconditionals="80" methods="46" coveredmethods="45"/>
-      <line num="1" count="2" type="stmt"/>
-      <line num="2" count="2" type="stmt"/>
-      <line num="3" count="2" type="stmt"/>
-      <line num="7" count="2" type="stmt"/>
-      <line num="8" count="1" type="stmt"/>
-      <line num="11" count="2" type="stmt"/>
-      <line num="12" count="1" type="stmt"/>
-      <line num="15" count="2" type="stmt"/>
-      <line num="16" count="3" type="cond" truecount="3" falsecount="1"/>
-      <line num="17" count="3" type="stmt"/>
-      <line num="19" count="0" type="stmt"/>
-      <line num="23" count="2" type="stmt"/>
-      <line num="24" count="3" type="cond" truecount="2" falsecount="0"/>
-      <line num="27" count="2" type="stmt"/>
-      <line num="28" count="1" type="cond" truecount="3" falsecount="1"/>
-      <line num="29" count="1" type="stmt"/>
-      <line num="31" count="0" type="stmt"/>
-      <line num="35" count="2" type="stmt"/>
-      <line num="37" count="2" type="cond" truecount="1" falsecount="1"/>
-      <line num="43" count="2" type="stmt"/>
-      <line num="44" count="2" type="cond" truecount="3" falsecount="1"/>
-      <line num="46" count="2" type="stmt"/>
-      <line num="47" count="2" type="stmt"/>
-      <line num="50" count="2" type="stmt"/>
-      <line num="55" count="3" type="stmt"/>
-      <line num="57" count="3" type="stmt"/>
-      <line num="59" count="3" type="cond" truecount="3" falsecount="1"/>
-      <line num="60" count="3" type="stmt"/>
-      <line num="62" count="0" type="stmt"/>
-      <line num="63" count="0" type="stmt"/>
-      <line num="66" count="3" type="stmt"/>
-      <line num="69" count="2" type="stmt"/>
-      <line num="75" count="1" type="stmt"/>
-      <line num="77" count="1" type="stmt"/>
-      <line num="83" count="1" type="cond" truecount="3" falsecount="1"/>
-      <line num="84" count="1" type="stmt"/>
-      <line num="86" count="0" type="stmt"/>
-      <line num="87" count="0" type="stmt"/>
-      <line num="90" count="1" type="stmt"/>
-      <line num="93" count="2" type="stmt"/>
-      <line num="97" count="3" type="stmt"/>
-      <line num="98" count="3" type="stmt"/>
-      <line num="100" count="3" type="stmt"/>
-      <line num="102" count="3" type="cond" truecount="4" falsecount="0"/>
-      <line num="103" count="1" type="stmt"/>
-      <line num="105" count="2" type="stmt"/>
-      <line num="108" count="0" type="stmt"/>
-      <line num="111" count="3" type="stmt"/>
-      <line num="114" count="2" type="stmt"/>
-      <line num="119" count="1" type="stmt"/>
-      <line num="120" count="1" type="stmt"/>
-      <line num="122" count="1" type="stmt"/>
-      <line num="124" count="1" type="cond" truecount="3" falsecount="1"/>
-      <line num="125" count="1" type="stmt"/>
-      <line num="127" count="0" type="stmt"/>
-      <line num="130" count="0" type="stmt"/>
-      <line num="133" count="1" type="stmt"/>
-      <line num="136" count="2" type="stmt"/>
-      <line num="140" count="1" type="stmt"/>
-      <line num="141" count="1" type="stmt"/>
-      <line num="143" count="1" type="stmt"/>
-      <line num="145" count="1" type="cond" truecount="3" falsecount="1"/>
-      <line num="146" count="1" type="stmt"/>
-      <line num="148" count="0" type="stmt"/>
-      <line num="151" count="0" type="stmt"/>
-      <line num="154" count="1" type="stmt"/>
-      <line num="157" count="2" type="stmt"/>
-      <line num="158" count="1" type="stmt"/>
-      <line num="159" count="1" type="stmt"/>
-      <line num="160" count="1" type="stmt"/>
-      <line num="161" count="1" type="stmt"/>
-      <line num="167" count="2" type="stmt"/>
-      <line num="168" count="1" type="stmt"/>
-      <line num="169" count="1" type="stmt"/>
-      <line num="170" count="1" type="stmt"/>
-      <line num="175" count="2" type="stmt"/>
-      <line num="176" count="1" type="stmt"/>
-      <line num="177" count="1" type="stmt"/>
-      <line num="178" count="1" type="stmt"/>
-      <line num="183" count="2" type="stmt"/>
-      <line num="184" count="3" type="stmt"/>
-      <line num="185" count="3" type="stmt"/>
-      <line num="186" count="3" type="stmt"/>
-      <line num="191" count="2" type="stmt"/>
-      <line num="192" count="1" type="stmt"/>
-      <line num="193" count="1" type="stmt"/>
-      <line num="194" count="1" type="stmt"/>
-      <line num="199" count="2" type="stmt"/>
-      <line num="200" count="1" type="stmt"/>
-      <line num="201" count="1" type="stmt"/>
-      <line num="202" count="1" type="stmt"/>
-      <line num="207" count="2" type="stmt"/>
-      <line num="208" count="0" type="stmt"/>
-      <line num="214" count="2" type="stmt"/>
-      <line num="215" count="1" type="cond" truecount="1" falsecount="1"/>
-      <line num="216" count="0" type="stmt"/>
-      <line num="220" count="2" type="stmt"/>
-      <line num="225" count="5" type="cond" truecount="3" falsecount="1"/>
-      <line num="226" count="5" type="stmt"/>
-      <line num="228" count="0" type="stmt"/>
-      <line num="232" count="2" type="stmt"/>
-      <line num="233" count="4" type="cond" truecount="3" falsecount="1"/>
-      <line num="234" count="4" type="stmt"/>
-      <line num="236" count="0" type="stmt"/>
-      <line num="240" count="2" type="stmt"/>
-      <line num="244" count="1" type="cond" truecount="3" falsecount="1"/>
-      <line num="245" count="1" type="stmt"/>
-      <line num="247" count="0" type="stmt"/>
-      <line num="251" count="2" type="stmt"/>
-      <line num="256" count="5" type="cond" truecount="3" falsecount="1"/>
-      <line num="257" count="5" type="stmt"/>
-      <line num="259" count="0" type="stmt"/>
-      <line num="263" count="2" type="stmt"/>
-      <line num="267" count="7" type="cond" truecount="4" falsecount="0"/>
-      <line num="268" count="5" type="stmt"/>
-      <line num="270" count="2" type="stmt"/>
-      <line num="274" count="2" type="stmt"/>
-      <line num="279" count="4" type="stmt"/>
-      <line num="282" count="4" type="stmt"/>
-      <line num="285" count="4" type="cond" truecount="2" falsecount="2"/>
-      <line num="286" count="4" type="stmt"/>
-      <line num="288" count="0" type="stmt"/>
-      <line num="292" count="2" type="stmt"/>
-      <line num="298" count="1" type="stmt"/>
-      <line num="301" count="1" type="stmt"/>
-      <line num="304" count="1" type="cond" truecount="2" falsecount="2"/>
-      <line num="305" count="1" type="stmt"/>
-      <line num="307" count="0" type="stmt"/>
-      <line num="311" count="2" type="stmt"/>
-      <line num="313" count="6" type="stmt"/>
-      <line num="315" count="6" type="cond" truecount="2" falsecount="0"/>
-      <line num="316" count="2" type="stmt"/>
-      <line num="320" count="4" type="stmt"/>
-      <line num="323" count="4" type="cond" truecount="4" falsecount="0"/>
-      <line num="324" count="3" type="stmt"/>
-      <line num="327" count="1" type="stmt"/>
-      <line num="330" count="2" type="stmt"/>
-      <line num="332" count="1" type="stmt"/>
-      <line num="334" count="1" type="cond" truecount="1" falsecount="1"/>
-      <line num="335" count="0" type="stmt"/>
-      <line num="339" count="1" type="stmt"/>
-      <line num="342" count="1" type="cond" truecount="2" falsecount="2"/>
-      <line num="343" count="1" type="stmt"/>
-      <line num="346" count="0" type="stmt"/>
-      <line num="349" count="2" type="stmt"/>
-      <line num="351" count="1" type="stmt"/>
-      <line num="353" count="1" type="cond" truecount="1" falsecount="1"/>
-      <line num="354" count="0" type="stmt"/>
-      <line num="358" count="1" type="stmt"/>
-      <line num="361" count="1" type="cond" truecount="2" falsecount="2"/>
-      <line num="362" count="1" type="stmt"/>
-      <line num="365" count="0" type="stmt"/>
-      <line num="368" count="2" type="stmt"/>
-      <line num="372" count="4" type="stmt"/>
-      <line num="374" count="4" type="cond" truecount="3" falsecount="1"/>
-      <line num="375" count="4" type="stmt"/>
-      <line num="377" count="0" type="stmt"/>
-      <line num="378" count="0" type="stmt"/>
-      <line num="382" count="4" type="cond" truecount="3" falsecount="1"/>
-      <line num="383" count="0" type="stmt"/>
-      <line num="384" count="0" type="stmt"/>
-      <line num="387" count="4" type="cond" truecount="1" falsecount="1"/>
-      <line num="388" count="4" type="cond" truecount="1" falsecount="1"/>
-      <line num="390" count="0" type="stmt"/>
-      <line num="391" count="0" type="stmt"/>
-      <line num="395" count="2" type="stmt"/>
-      <line num="396" count="1" type="cond" truecount="3" falsecount="1"/>
-      <line num="397" count="1" type="stmt"/>
-      <line num="399" count="0" type="stmt"/>
-      <line num="402" count="0" type="stmt"/>
-      <line num="405" count="2" type="stmt"/>
-      <line num="406" count="5" type="stmt"/>
-      <line num="408" count="5" type="cond" truecount="3" falsecount="1"/>
-      <line num="409" count="5" type="stmt"/>
-      <line num="411" count="0" type="stmt"/>
-      <line num="414" count="5" type="cond" truecount="2" falsecount="0"/>
-      <line num="415" count="4" type="stmt"/>
-      <line num="418" count="1" type="stmt"/>
-      <line num="421" count="2" type="stmt"/>
-      <line num="422" count="1" type="cond" truecount="3" falsecount="1"/>
-      <line num="423" count="1" type="stmt"/>
-      <line num="425" count="0" type="stmt"/>
-    </file>
-    <file name="jwtRoles.ts" path="/Users/pankajpriscilla/SO_CareCardCa/pkg-jwt-read/src/jwtRoles.ts">
-      <metrics statements="6" coveredstatements="6" conditionals="4" coveredconditionals="4" methods="2" coveredmethods="2"/>
-      <line num="1" count="2" type="stmt"/>
-      <line num="8" count="2" type="stmt"/>
-      <line num="10" count="3" type="cond" truecount="2" falsecount="0"/>
-      <line num="13" count="2" type="stmt"/>
-      <line num="20" count="2" type="stmt"/>
-      <line num="21" count="3" type="cond" truecount="2" falsecount="0"/>
-    </file>
-  </project>
-</coverage>