@codisolutions23/node-utils 3.0.1 → 3.1.0

package/.changeset/shiny-donkeys-glow.md

@@ -0,0 +1,11 @@
+### Minor Changes
+
+- **Cache System Improvements**: Enhanced cache utility with clearer function names (`getCache`, `setCache`, `delCache`, `delCacheGroup`) and configurable TTL settings via `CACHE_SHORT_TTL` and `CACHE_LONG_TTL` environment variables
+
+- **Enhanced Error Handling**: Replaced generic Error with NotFoundError for missing environment variables, providing better error specificity and handling
+
+- **Reduced Auth Logging**: Optimized authentication middleware logging to reduce production noise while maintaining debug capabilities in development
+
+### Patch Changes
+
+- **Dependencies**: Updated AWS SDK packages (@aws-sdk, @smithy) to latest versions (3.908.0, 4.x) for improved security and compatibility

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @codisolutions23/node-utils
 
+## 3.0.2
+
+### Patch Changes
+
+- c740901: **Patch Changes and Improvements**
+
+  - **Dependencies**: Upgraded @aws-sdk and @smithy packages from v3.883.0 to v3.890.0, bringing latest features, bug fixes, and security improvements
+  - **Template Resolution**: Enhanced getTemplatePath to check multiple locations (src/public, public, provided directory) with fallback to src/public for improved flexibility
+  - **Handlebars Helpers**: Added formatCurrency for Philippine peso formatting and formatDate for flexible date formatting
+  - **Authentication Middleware**: Refactored for better modularity, added admin and role-based access control, improved logging and error handling with token revocation checks
+
 ## 3.0.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -6,14 +6,26 @@ import Redis from 'ioredis';
 import * as winston from 'winston';
 import { RedisClientType } from 'redis';
 
+interface DecodedToken extends JwtPayload {
+    user?: string;
+    id?: string;
+    jti?: string;
+    role?: string;
+}
 interface AuthenticatedRequest extends Request {
-    user?: JwtPayload & {
-        user?: string;
-        id?: string;
+    user?: DecodedToken & {
+        id: string;
     };
     token?: string;
 }
+interface AuthOptions {
+    secretKey?: string;
+    isTokenRevoked?: (jti: string) => Promise<boolean>;
+    requiredRole?: string;
+}
 declare function authenticate(secretKey?: string, isTokenRevoked?: (jti: string) => Promise<boolean>): (req: AuthenticatedRequest, res: Response, next: NextFunction) => Promise<void>;
+declare function requireAdmin(secretKey?: string, isTokenRevoked?: (jti: string) => Promise<boolean>): (req: AuthenticatedRequest, res: Response, next: NextFunction) => Promise<void>;
+declare function requireRole(role: string, options?: Omit<AuthOptions, "requiredRole">): (req: AuthenticatedRequest, res: Response, next: NextFunction) => Promise<void>;
 
 declare class HttpError extends Error {
     readonly statusCode: number;
@@ -60,10 +72,10 @@ declare class useAtlas {
 }
 
 declare function useCache(): {
-    get: <T = unknown>(cacheKey: string) => Promise<T | null>;
-    set: <T = unknown>(cacheKey: string, data: T, ttl?: number, group?: string) => Promise<void>;
-    remove: (cacheKey: string) => Promise<void>;
-    clearGroup: (group: string) => Promise<void>;
+    getCache: <T = unknown>(cacheKey: string) => Promise<T | null>;
+    setCache: <T = unknown>(cacheKey: string, data: T, ttl?: number, group?: string) => Promise<void>;
+    delCache: (cacheKey: string) => Promise<void>;
+    delCacheGroup: (group: string) => Promise<void>;
 };
 
 declare function buildCacheKey(prefix: string, values: Record<string, any>): string;
@@ -154,4 +166,4 @@ declare class useS3 {
 
 declare function hashToken(token: string): string;
 
-export { type AuthenticatedRequest, BadRequestError, ConflictError, ForbiddenError, HttpError, InternalServerError, NotFoundError, UnauthorizedError, UnprocessableEntityError, authenticate, buildCacheKey, comparePasswords, errorHandler, getTemplatePath, hashPassword, hashToken, initRedisClient, logger, paginate, renderHandlebarsTemplate, signJwtToken, toObjectId, useAtlas, useCache, useMailer, useRedis, useRedisClient, useS3 };
+export { type AuthenticatedRequest, BadRequestError, ConflictError, ForbiddenError, HttpError, InternalServerError, NotFoundError, UnauthorizedError, UnprocessableEntityError, authenticate, buildCacheKey, comparePasswords, errorHandler, getTemplatePath, hashPassword, hashToken, initRedisClient, logger, paginate, renderHandlebarsTemplate, requireAdmin, requireRole, signJwtToken, toObjectId, useAtlas, useCache, useMailer, useRedis, useRedisClient, useS3 };

package/dist/index.d.ts

@@ -6,14 +6,26 @@ import Redis from 'ioredis';
 import * as winston from 'winston';
 import { RedisClientType } from 'redis';
 
+interface DecodedToken extends JwtPayload {
+    user?: string;
+    id?: string;
+    jti?: string;
+    role?: string;
+}
 interface AuthenticatedRequest extends Request {
-    user?: JwtPayload & {
-        user?: string;
-        id?: string;
+    user?: DecodedToken & {
+        id: string;
     };
     token?: string;
 }
+interface AuthOptions {
+    secretKey?: string;
+    isTokenRevoked?: (jti: string) => Promise<boolean>;
+    requiredRole?: string;
+}
 declare function authenticate(secretKey?: string, isTokenRevoked?: (jti: string) => Promise<boolean>): (req: AuthenticatedRequest, res: Response, next: NextFunction) => Promise<void>;
+declare function requireAdmin(secretKey?: string, isTokenRevoked?: (jti: string) => Promise<boolean>): (req: AuthenticatedRequest, res: Response, next: NextFunction) => Promise<void>;
+declare function requireRole(role: string, options?: Omit<AuthOptions, "requiredRole">): (req: AuthenticatedRequest, res: Response, next: NextFunction) => Promise<void>;
 
 declare class HttpError extends Error {
     readonly statusCode: number;
@@ -60,10 +72,10 @@ declare class useAtlas {
 }
 
 declare function useCache(): {
-    get: <T = unknown>(cacheKey: string) => Promise<T | null>;
-    set: <T = unknown>(cacheKey: string, data: T, ttl?: number, group?: string) => Promise<void>;
-    remove: (cacheKey: string) => Promise<void>;
-    clearGroup: (group: string) => Promise<void>;
+    getCache: <T = unknown>(cacheKey: string) => Promise<T | null>;
+    setCache: <T = unknown>(cacheKey: string, data: T, ttl?: number, group?: string) => Promise<void>;
+    delCache: (cacheKey: string) => Promise<void>;
+    delCacheGroup: (group: string) => Promise<void>;
 };
 
 declare function buildCacheKey(prefix: string, values: Record<string, any>): string;
@@ -154,4 +166,4 @@ declare class useS3 {
 
 declare function hashToken(token: string): string;
 
-export { type AuthenticatedRequest, BadRequestError, ConflictError, ForbiddenError, HttpError, InternalServerError, NotFoundError, UnauthorizedError, UnprocessableEntityError, authenticate, buildCacheKey, comparePasswords, errorHandler, getTemplatePath, hashPassword, hashToken, initRedisClient, logger, paginate, renderHandlebarsTemplate, signJwtToken, toObjectId, useAtlas, useCache, useMailer, useRedis, useRedisClient, useS3 };
+export { type AuthenticatedRequest, BadRequestError, ConflictError, ForbiddenError, HttpError, InternalServerError, NotFoundError, UnauthorizedError, UnprocessableEntityError, authenticate, buildCacheKey, comparePasswords, errorHandler, getTemplatePath, hashPassword, hashToken, initRedisClient, logger, paginate, renderHandlebarsTemplate, requireAdmin, requireRole, signJwtToken, toObjectId, useAtlas, useCache, useMailer, useRedis, useRedisClient, useS3 };

package/dist/index.js

@@ -86,6 +86,8 @@ __export(index_exports, {
   logger: () => logger,
   paginate: () => paginate,
   renderHandlebarsTemplate: () => renderHandlebarsTemplate,
+  requireAdmin: () => requireAdmin,
+  requireRole: () => requireRole,
   signJwtToken: () => signJwtToken,
   toObjectId: () => toObjectId,
   useAtlas: () => useAtlas,
@@ -164,40 +166,143 @@ var InternalServerError = class extends HttpError {
 };
 
 // src/middleware/auth.middleware.ts
-function authenticate(secretKey = process.env.ACCESS_TOKEN_SECRET || "", isTokenRevoked) {
-  return (req, res, next) => __async(null, null, function* () {
-    const authHeader = req.headers.authorization;
-    const token = authHeader == null ? void 0 : authHeader.split(" ")[1];
+function extractToken(authHeader) {
+  if (!authHeader) {
+    return null;
+  }
+  if (!authHeader.startsWith("Bearer ")) {
+    logger.warn("Invalid Authorization header format", {
+      format: "Expected 'Bearer <token>'"
+    });
+    return null;
+  }
+  return authHeader.split(" ")[1] || null;
+}
+function authenticateToken(req, options) {
+  return __async(this, null, function* () {
+    const {
+      secretKey = process.env.ACCESS_TOKEN_SECRET || "",
+      isTokenRevoked,
+      requiredRole
+    } = options;
+    const requestId = req.headers["x-request-id"] || "unknown";
+    const isDev = process.env.NODE_ENV === "development";
+    if (isDev) {
+      logger.debug("Starting authentication process", {
+        requestId,
+        path: req.path,
+        requiredRole
+      });
+    }
+    const token = extractToken(req.headers.authorization);
     if (!token) {
-      logger.error("No access token provided in the request.");
-      return next(
-        new UnauthorizedError("Access token is required to proceed.")
-      );
+      logger.error("Authentication failed: No access token provided", {
+        requestId,
+        path: req.path
+      });
+      throw new UnauthorizedError("Access token is required to proceed.");
     }
+    let decoded;
     try {
-      const decoded = import_jsonwebtoken.default.verify(token, secretKey);
-      if (isTokenRevoked && decoded.jti && (yield isTokenRevoked(decoded.jti))) {
-        logger.warn("Access token is revoked (blacklisted).", {
-          jti: decoded.jti
+      decoded = import_jsonwebtoken.default.verify(token, secretKey);
+      if (isDev) {
+        logger.debug("JWT token verified", {
+          requestId,
+          userId: decoded.user || decoded.id,
+          role: decoded.role
+        });
+      }
+    } catch (error) {
+      logger.error("JWT verification failed", {
+        requestId,
+        error: error instanceof Error ? error.message : "Invalid token",
+        path: req.path
+      });
+      throw new UnauthorizedError(
+        "Your session has expired or the token is invalid. Please log in again."
+      );
+    }
+    if (isTokenRevoked && decoded.jti) {
+      const isRevoked = yield isTokenRevoked(decoded.jti);
+      if (isRevoked) {
+        logger.warn("Authentication failed: Token is revoked", {
+          requestId,
+          jti: decoded.jti,
+          userId: decoded.user || decoded.id
         });
-        return next(
-          new UnauthorizedError(
-            "Your session has expired or the token is invalid. Please log in again."
-          )
+        throw new UnauthorizedError(
+          "Your session has expired or the token is invalid. Please log in again."
         );
       }
-      req.user = __spreadProps(__spreadValues({}, decoded), {
-        id: decoded.user || decoded.id
+    }
+    if (requiredRole && decoded.role !== requiredRole) {
+      logger.warn("Authorization failed: Insufficient permissions", {
+        requestId,
+        userId: decoded.user || decoded.id,
+        userRole: decoded.role,
+        requiredRole,
+        path: req.path
+      });
+      throw new ForbiddenError(
+        "Insufficient permissions to access this resource."
+      );
+    }
+    req.user = __spreadProps(__spreadValues({}, decoded), {
+      id: decoded.user || decoded.id || ""
+    });
+    req.token = token;
+    if (isDev) {
+      logger.debug("Authentication completed successfully", {
+        requestId,
+        userId: req.user.id,
+        role: req.user.role
+      });
+    }
+  });
+}
+function authenticate(secretKey = process.env.ACCESS_TOKEN_SECRET || "", isTokenRevoked) {
+  return (req, res, next) => __async(null, null, function* () {
+    try {
+      yield authenticateToken(req, { secretKey, isTokenRevoked });
+      next();
+    } catch (error) {
+      logger.error("Authenticate middleware failed", {
+        error: error instanceof Error ? error.message : "Unknown error"
+      });
+      next(error);
+    }
+  });
+}
+function requireAdmin(secretKey = process.env.ACCESS_TOKEN_SECRET || "", isTokenRevoked) {
+  return (req, res, next) => __async(null, null, function* () {
+    try {
+      yield authenticateToken(req, {
+        secretKey,
+        isTokenRevoked,
+        requiredRole: "admin"
       });
-      req.token = token;
       next();
     } catch (error) {
-      logger.error("Failed to verify access token.", error);
-      return next(
-        new UnauthorizedError(
-          "Your session has expired or the token is invalid. Please log in again."
-        )
-      );
+      logger.error("RequireAdmin middleware failed", {
+        error: error instanceof Error ? error.message : "Unknown error"
+      });
+      next(error);
+    }
+  });
+}
+function requireRole(role, options) {
+  return (req, res, next) => __async(null, null, function* () {
+    try {
+      yield authenticateToken(req, __spreadProps(__spreadValues({}, options), {
+        requiredRole: role
+      }));
+      next();
+    } catch (error) {
+      logger.error("RequireRole middleware failed", {
+        requiredRole: role,
+        error: error instanceof Error ? error.message : "Unknown error"
+      });
+      next(error);
     }
   });
 }
@@ -294,6 +399,34 @@ var useAtlas = class {
 useAtlas.mongoClient = null;
 useAtlas.mongoDb = null;
 
+// src/config.ts
+var dotenv = __toESM(require("dotenv"));
+dotenv.config();
+function getEnv(key, fallback) {
+  const value = process.env[key];
+  if (value !== void 0) return value;
+  if (fallback !== void 0) return fallback;
+  throw new NotFoundError(`Missing required environment variable: ${key}`);
+}
+function getEnvNumber(key, fallback) {
+  const value = process.env[key];
+  if (value !== void 0) return Number(value);
+  if (fallback !== void 0) return fallback;
+  throw new NotFoundError(`Missing required environment variable: ${key}`);
+}
+function getEnvBoolean(key, fallback) {
+  const value = process.env[key];
+  if (value !== void 0) return value === "true";
+  if (fallback !== void 0) return fallback;
+  throw new NotFoundError(`Missing required environment variable: ${key}`);
+}
+var REDIS_HOST = getEnv("REDIS_HOST");
+var REDIS_PORT = getEnvNumber("REDIS_PORT", 6379);
+var REDIS_PASSWORD = getEnv("REDIS_PASSWORD");
+var REDIS_TLS = getEnvBoolean("REDIS_TLS", true);
+var CACHE_SHORT_TTL = getEnvNumber("CACHE_SHORT_TTL", 300);
+var CACHE_LONG_TTL = getEnvNumber("CACHE_LONG_TTL", 3600);
+
 // src/utils/ioredis.ts
 var import_ioredis = __toESM(require("ioredis"));
 var redisClient = null;
@@ -352,12 +485,11 @@ function useRedis() {
 }
 
 // src/utils/cache.ts
-var DEFAULT_TTL = 300;
 function useCache() {
   function getRedisClient() {
     return useRedis().getClient();
   }
-  function get(cacheKey) {
+  function getCache(cacheKey) {
     return __async(this, null, function* () {
       try {
         const redisClient3 = getRedisClient();
@@ -371,13 +503,16 @@ function useCache() {
       }
     });
   }
-  function set(_0, _1) {
-    return __async(this, arguments, function* (cacheKey, data, ttl = DEFAULT_TTL, group) {
+  function setCache(_0, _1) {
+    return __async(this, arguments, function* (cacheKey, data, ttl = CACHE_SHORT_TTL, group) {
       try {
         const redisClient3 = getRedisClient();
         yield redisClient3.set(cacheKey, JSON.stringify(data), "EX", ttl);
         logger.info(`[Cache][Set] Stored key "${cacheKey}" with TTL ${ttl}s.`);
-        if (group) yield redisClient3.sadd(`cache:group:${group}`, cacheKey);
+        if (group) {
+          yield redisClient3.sadd(`cache:group:${group}`, cacheKey);
+          yield redisClient3.expire(`cache:group:${group}`, CACHE_LONG_TTL);
+        }
       } catch (error) {
         logger.error(
           `[Cache][Set] Failed to store key "${cacheKey}": ${error instanceof Error ? error.message : error}`
@@ -385,7 +520,7 @@ function useCache() {
       }
     });
   }
-  function remove(cacheKey) {
+  function delCache(cacheKey) {
     return __async(this, null, function* () {
       try {
         const redisClient3 = getRedisClient();
@@ -398,7 +533,7 @@ function useCache() {
       }
     });
   }
-  function clearGroup(group) {
+  function delCacheGroup(group) {
     return __async(this, null, function* () {
       try {
         const redisClient3 = getRedisClient();
@@ -414,10 +549,10 @@ function useCache() {
     });
   }
   return {
-    get,
-    set,
-    remove,
-    clearGroup
+    getCache,
+    setCache,
+    delCache,
+    delCacheGroup
   };
 }
 
@@ -434,13 +569,58 @@ var import_path = __toESM(require("path"));
 function getTemplatePath(directory, filePath) {
   const ext = ".hbs";
   const file = filePath.endsWith(ext) ? filePath : `${filePath}${ext}`;
-  return import_path.default.resolve(directory, file);
+  const possiblePaths = [
+    import_path.default.join(process.cwd(), "src", "public", directory, file),
+    import_path.default.join(process.cwd(), "public", directory, file),
+    import_path.default.join(process.cwd(), directory, file)
+  ];
+  const fs2 = require("fs");
+  for (const templatePath of possiblePaths) {
+    if (fs2.existsSync(templatePath)) {
+      return templatePath;
+    }
+  }
+  return possiblePaths[0];
 }
 
 // src/utils/handlebars-compiler.ts
 var import_handlebars = __toESM(require("handlebars"));
 var import_fs = require("fs");
 var handlebarsTemplateCache = /* @__PURE__ */ new Map();
+import_handlebars.default.registerHelper("formatCurrency", function(amount) {
+  if (typeof amount !== "number") return "0.00";
+  return new Intl.NumberFormat("en-PH", {
+    style: "decimal",
+    minimumFractionDigits: 2,
+    maximumFractionDigits: 2
+  }).format(amount);
+});
+import_handlebars.default.registerHelper(
+  "formatDate",
+  function(date, format2) {
+    if (!date) return "N/A";
+    const dateObj = typeof date === "string" ? new Date(date) : date;
+    if (isNaN(dateObj.getTime())) return "N/A";
+    const options = {};
+    if (format2.includes("MMMM")) options.month = "long";
+    else if (format2.includes("MMM")) options.month = "short";
+    else if (format2.includes("MM")) options.month = "2-digit";
+    if (format2.includes("D,")) options.day = "numeric";
+    else if (format2.includes("DD")) options.day = "2-digit";
+    if (format2.includes("YYYY")) options.year = "numeric";
+    else if (format2.includes("YY")) options.year = "2-digit";
+    if (format2.includes("h:mm A")) {
+      options.hour = "numeric";
+      options.minute = "2-digit";
+      options.hour12 = true;
+    } else if (format2.includes("HH:mm")) {
+      options.hour = "2-digit";
+      options.minute = "2-digit";
+      options.hour12 = false;
+    }
+    return new Intl.DateTimeFormat("en-US", options).format(dateObj);
+  }
+);
 function renderHandlebarsTemplate(_0) {
   return __async(this, arguments, function* ({
     context = {},
@@ -617,34 +797,6 @@ function hashPassword(_0) {
 
 // src/utils/redis.ts
 var import_redis = require("redis");
-
-// src/config.ts
-var dotenv = __toESM(require("dotenv"));
-dotenv.config();
-function getEnv(key, fallback) {
-  const value = process.env[key];
-  if (value !== void 0) return value;
-  if (fallback !== void 0) return fallback;
-  throw new Error(`Missing required environment variable: ${key}`);
-}
-function getEnvNumber(key, fallback) {
-  const value = process.env[key];
-  if (value !== void 0) return Number(value);
-  if (fallback !== void 0) return fallback;
-  throw new Error(`Missing required environment variable: ${key}`);
-}
-function getEnvBoolean(key, fallback) {
-  const value = process.env[key];
-  if (value !== void 0) return value === "true";
-  if (fallback !== void 0) return fallback;
-  throw new Error(`Missing required environment variable: ${key}`);
-}
-var REDIS_HOST = getEnv("REDIS_HOST");
-var REDIS_PORT = getEnvNumber("REDIS_PORT", 6379);
-var REDIS_PASSWORD = getEnv("REDIS_PASSWORD");
-var REDIS_TLS = getEnvBoolean("REDIS_TLS", true);
-
-// src/utils/redis.ts
 var redisClient2 = null;
 function initRedisClient() {
   return __async(this, null, function* () {
@@ -767,6 +919,8 @@ function hashToken(token) {
   logger,
   paginate,
   renderHandlebarsTemplate,
+  requireAdmin,
+  requireRole,
   signJwtToken,
   toObjectId,
   useAtlas,