@carecard/jwt-read 3.0.2 → 3.0.4

package/index.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Utility functions for reading and verifying JWTs.
+ */
+
+import { Request, Response, NextFunction } from 'express';
+
+/**
+ * Returns a middleware that verifies a JWT from the 'Authorization: Bearer <token>' header
+ * and extracts it into req.jwt. Throws an error if invalid.
+ */
+export function verifyJwt(publicKey: string, customErrorFunction?: () => void): (req: Request, res: Response, next: NextFunction) => void;
+
+/**
+ * Returns a middleware that verifies a JWT from a custom header and extracts it into req.jwt.
+ * Throws an error if invalid.
+ */
+export function verifyWebToken(publicKey: string, headerName: string, customErrorFunction?: () => void): (req: Request, res: Response, next: NextFunction) => void;
+
+/**
+ * Returns a middleware that 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(publicKey: string): (req: Request, res: Response, next: NextFunction) => void;
+
+/**
+ * Returns a middleware that verifies a JWT from a custom header and extracts it into req.jwt.
+ * Returns false instead of throwing if invalid.
+ */
+export function verifyWebTokenNoThrow(publicKey: string, headerName: string): (req: Request, res: Response, next: NextFunction) => void;
+
+/**
+ * Returns a middleware that verifies a visitor token from the 'Visitor' header
+ * and extracts it into req.visitor. Returns false instead of throwing if invalid.
+ */
+export function verifyVisitorNoThrow(publicKey: string): (req: Request, res: Response, next: NextFunction) => void;
+
+/**
+ * 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;
+
+/**
+ * Returns a middleware that verifies the JWT and checks if the user has the required role.
+ */
+export function verifyJwtAndRole(userRole: string, publicKey: string, customErrorFunction?: () => void): (req: Request, res: Response, next: NextFunction) => void;
+
+/**
+ * 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;
+export function doesJwtUserHasRole(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

@@ -79,7 +79,7 @@ function jwtAgeInSeconds( req ) {
     }
 }
 
-async function validateAndExtractJwtObject( req, publicKey, customErrorFunction ) {
+function validateAndExtractJwtObject( req, publicKey, customErrorFunction ) {
 
     const jwtString = _validateJwt( req, customErrorFunction );
 
@@ -92,10 +92,10 @@ async function validateAndExtractJwtObject( req, publicKey, customErrorFunction
         throwError( customErrorFunction );
     }
 
-    return req;
+    return Promise.resolve( req );
 }
 
-async function validateAndExtractWebToken( req, publicKey, headerName, customErrorFunction ) {
+function validateAndExtractWebToken( req, publicKey, headerName, customErrorFunction ) {
 
     const webTokenString = _validateWebToken( req, headerName, customErrorFunction );
 
@@ -108,10 +108,10 @@ async function validateAndExtractWebToken( req, publicKey, headerName, customErr
         throwError( customErrorFunction );
     }
 
-    return req;
+    return Promise.resolve( req );
 }
 
-async function validateAndExtractJwtObjectNoThrow( req, publicKey ) {
+function validateAndExtractJwtObjectNoThrow( req, publicKey ) {
 
     try {
 
@@ -131,10 +131,10 @@ async function validateAndExtractJwtObjectNoThrow( req, publicKey ) {
 
     }
 
-    return req;
+    return Promise.resolve( req );
 }
 
-async function validateAndExtractWebTokenObjectNoThrow( req, publicKey, headerName ) {
+function validateAndExtractWebTokenObjectNoThrow( req, publicKey, headerName ) {
 
     try {
 
@@ -154,10 +154,10 @@ async function validateAndExtractWebTokenObjectNoThrow( req, publicKey, headerNa
 
     }
 
-    return req;
+    return Promise.resolve( req );
 }
 
-async function validateAndExtractVisitorObjectNoThrow( req, publicKey ) {
+function validateAndExtractVisitorObjectNoThrow( req, publicKey ) {
 
     try {
 
@@ -177,12 +177,12 @@ async function validateAndExtractVisitorObjectNoThrow( req, publicKey ) {
 
     }
 
-    return req;
+    return Promise.resolve( req );
 }
 
 function verifyJwtAndRole( role, publicKey, customErrorFunction ) {
-    return async function ( req, res, next ) {
-        await validateAndExtractJwtObject( req, publicKey, customErrorFunction )
+    return function ( req, res, next ) {
+        validateAndExtractJwtObject( req, publicKey, customErrorFunction )
             .then( req => doesJwtUserHasRole( req, role ) )
             .then( isRoleExist => _isLoginRequired( isRoleExist, customErrorFunction ) )
             .then( () => next() )
@@ -191,41 +191,41 @@ function verifyJwtAndRole( role, publicKey, customErrorFunction ) {
 }
 
 function verifyJwt( publicKey, customErrorFunction ) {
-    return async function ( req, res, next ) {
-        await validateAndExtractJwtObject( req, publicKey, customErrorFunction )
-            .then( () => process.nextTick( next ) )
+    return function ( req, res, next ) {
+        validateAndExtractJwtObject( req, publicKey, customErrorFunction )
+            .then( () => next() )
             .catch( next );
     }
 }
 
 function verifyWebToken( publicKey, headerName, customErrorFunction ) {
-    return async function ( req, res, next ) {
-        await validateAndExtractWebToken( req, publicKey, headerName, customErrorFunction )
-            .then( () => process.nextTick( next ) )
+    return function ( req, res, next ) {
+        validateAndExtractWebToken( req, publicKey, headerName, customErrorFunction )
+            .then( () => next() )
             .catch( next );
     }
 }
 
 function verifyJwtNoThrow( publicKey ) {
-    return async function ( req, res, next ) {
-        await validateAndExtractJwtObjectNoThrow( req, publicKey )
-            .then( () => process.nextTick( next ) )
+    return function ( req, res, next ) {
+        validateAndExtractJwtObjectNoThrow( req, publicKey )
+            .then( () => next() )
             .catch( next );
     }
 }
 
 function verifyWebTokenNoThrow( publicKey, headerName ) {
-    return async function ( req, res, next ) {
-        await validateAndExtractWebTokenObjectNoThrow( req, publicKey, headerName )
-            .then( () => process.nextTick( next ) )
+    return function ( req, res, next ) {
+        validateAndExtractWebTokenObjectNoThrow( req, publicKey, headerName )
+            .then( () => next() )
             .catch( next );
     }
 }
 
 function verifyVisitorNoThrow( publicKey ) {
-    return async function ( req, res, next ) {
-        await validateAndExtractVisitorObjectNoThrow( req, publicKey )
-            .then( () => process.nextTick( next ) )
+    return function ( req, res, next ) {
+        validateAndExtractVisitorObjectNoThrow( req, publicKey )
+            .then( () => next() )
             .catch( next );
     }
 }
@@ -294,7 +294,7 @@ function _attachVisitorMethods( visitorObj ) {
     }
 }
 
-async function _isJwtSignatureValid( jwt, publicKey, customErrorFunction ) {
+function _isJwtSignatureValid( jwt, publicKey, customErrorFunction ) {
 
     if ( jwt && typeof jwt === "string" ) {
         return jwtUtilAuth.verifyJwtSignature( jwt, publicKey )
@@ -303,7 +303,7 @@ async function _isJwtSignatureValid( jwt, publicKey, customErrorFunction ) {
     }
 }
 
-async function _isJwtSignatureValidNoThrow( jwt, publicKey ) {
+function _isJwtSignatureValidNoThrow( jwt, publicKey ) {
 
     if ( jwt && typeof jwt === "string" ) {
         return jwtUtilAuth.verifyJwtSignature( jwt, publicKey )

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@carecard/jwt-read",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "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 --recursive",
+    "test:types": "tsc --noEmit && mocha -r ts-node/register test/types.test.ts"
   },
   "keywords": [
     "auth",
@@ -18,11 +20,16 @@
   "author": "CareCard team",
   "license": "ISC",
   "devDependencies": {
-    "mocha": "11.7.5"
+    "@types/express": "5.0.6",
+    "@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.2",
-    "@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"
   }
 }