@codisolutions23/node-utils 3.0.2 → 3.2.0

package/.changeset/README.md

@@ -1,8 +1,8 @@
-# Changesets
-
-Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
-with multi-package repos, or single-package repos to help you version and publish your code. You can
-find the full documentation for it [in our repository](https://github.com/changesets/changesets)
-
-We have a quick list of common questions to get you started engaging with this project in
-[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -1,11 +1,11 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
-  "changelog": "@changesets/cli/changelog",
-  "commit": false,
-  "fixed": [],
-  "linked": [],
-  "access": "restricted",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
-}
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @codisolutions23/node-utils
 
+## 3.2.0
+
+### Minor Changes
+
+- 3e1d36f: Enhanced cache system with clearer function names (`getCache`, `setCache`, `delCache`, `delCacheGroup`) and configurable TTL via environment variables. Improved error handling by replacing generic Error with NotFoundError for missing environment variables. Optimized authentication middleware logging to reduce production noise. Updated AWS SDK dependencies to latest versions.
+
+### Patch Changes
+
+- Extended `DecodedToken` and `AuthenticatedRequest` interfaces with index signatures to support additional JWT claims and user properties. This improves flexibility for handling custom data without TypeScript errors while maintaining backward compatibility.
+
 ## 3.0.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -11,10 +11,12 @@ interface DecodedToken extends JwtPayload {
     id?: string;
     jti?: string;
     role?: string;
+    [key: string]: any;
 }
 interface AuthenticatedRequest extends Request {
     user?: DecodedToken & {
         id: string;
+        [key: string]: any;
     };
     token?: string;
 }
@@ -72,10 +74,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;

package/dist/index.d.ts

@@ -11,10 +11,12 @@ interface DecodedToken extends JwtPayload {
     id?: string;
     jti?: string;
     role?: string;
+    [key: string]: any;
 }
 interface AuthenticatedRequest extends Request {
     user?: DecodedToken & {
         id: string;
+        [key: string]: any;
     };
     token?: string;
 }
@@ -72,10 +74,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;

package/dist/index.js

@@ -167,23 +167,16 @@ var InternalServerError = class extends HttpError {
 
 // src/middleware/auth.middleware.ts
 function extractToken(authHeader) {
-  logger.debug("Attempting to extract token from Authorization header");
   if (!authHeader) {
-    logger.debug("No Authorization header provided");
     return null;
   }
   if (!authHeader.startsWith("Bearer ")) {
-    logger.warn("Authorization header does not start with 'Bearer '", {
-      authHeader: authHeader.substring(0, 20) + "..."
+    logger.warn("Invalid Authorization header format", {
+      format: "Expected 'Bearer <token>'"
     });
     return null;
   }
-  const token = authHeader.split(" ")[1] || null;
-  logger.debug("Token extraction result", {
-    hasToken: !!token,
-    tokenLength: token == null ? void 0 : token.length
-  });
-  return token;
+  return authHeader.split(" ")[1] || null;
 }
 function authenticateToken(req, options) {
   return __async(this, null, function* () {
@@ -193,13 +186,14 @@ function authenticateToken(req, options) {
       requiredRole
     } = options;
     const requestId = req.headers["x-request-id"] || "unknown";
-    logger.info("Starting authentication process", {
-      requestId,
-      path: req.path,
-      method: req.method,
-      requiredRole,
-      hasRevocationCheck: !!isTokenRevoked
-    });
+    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("Authentication failed: No access token provided", {
@@ -208,36 +202,27 @@ function authenticateToken(req, options) {
       });
       throw new UnauthorizedError("Access token is required to proceed.");
     }
-    logger.debug("Token extracted successfully, proceeding with verification", {
-      requestId,
-      tokenLength: token.length
-    });
     let decoded;
     try {
-      logger.debug("Verifying JWT token", { requestId });
       decoded = import_jsonwebtoken.default.verify(token, secretKey);
-      logger.info("JWT token verified successfully", {
-        requestId,
-        userId: decoded.user || decoded.id,
-        role: decoded.role,
-        jti: decoded.jti,
-        exp: decoded.exp ? new Date(decoded.exp * 1e3).toISOString() : "unknown"
-      });
+      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 : "Unknown error",
-        tokenLength: token.length
+        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) {
-      logger.debug("Checking token revocation status", {
-        requestId,
-        jti: decoded.jti
-      });
       const isRevoked = yield isTokenRevoked(decoded.jti);
       if (isRevoked) {
         logger.warn("Authentication failed: Token is revoked", {
@@ -249,10 +234,6 @@ function authenticateToken(req, options) {
           "Your session has expired or the token is invalid. Please log in again."
         );
       }
-      logger.debug("Token revocation check passed", {
-        requestId,
-        jti: decoded.jti
-      });
     }
     if (requiredRole && decoded.role !== requiredRole) {
       logger.warn("Authorization failed: Insufficient permissions", {
@@ -270,31 +251,22 @@ function authenticateToken(req, options) {
       id: decoded.user || decoded.id || ""
     });
     req.token = token;
-    logger.info("Authentication completed successfully", {
-      requestId,
-      userId: req.user.id,
-      role: req.user.role,
-      path: req.path,
-      method: req.method
-    });
+    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* () {
-    const requestId = req.headers["x-request-id"] || "unknown";
-    logger.debug("Authenticate middleware invoked", {
-      requestId,
-      path: req.path
-    });
     try {
       yield authenticateToken(req, { secretKey, isTokenRevoked });
-      logger.debug("Authenticate middleware completed successfully", {
-        requestId
-      });
       next();
     } catch (error) {
       logger.error("Authenticate middleware failed", {
-        requestId,
         error: error instanceof Error ? error.message : "Unknown error"
       });
       next(error);
@@ -303,24 +275,15 @@ function authenticate(secretKey = process.env.ACCESS_TOKEN_SECRET || "", isToken
 }
 function requireAdmin(secretKey = process.env.ACCESS_TOKEN_SECRET || "", isTokenRevoked) {
   return (req, res, next) => __async(null, null, function* () {
-    const requestId = req.headers["x-request-id"] || "unknown";
-    logger.debug("RequireAdmin middleware invoked", {
-      requestId,
-      path: req.path
-    });
     try {
       yield authenticateToken(req, {
         secretKey,
         isTokenRevoked,
         requiredRole: "admin"
       });
-      logger.debug("RequireAdmin middleware completed successfully", {
-        requestId
-      });
       next();
     } catch (error) {
       logger.error("RequireAdmin middleware failed", {
-        requestId,
         error: error instanceof Error ? error.message : "Unknown error"
       });
       next(error);
@@ -329,24 +292,13 @@ function requireAdmin(secretKey = process.env.ACCESS_TOKEN_SECRET || "", isToken
 }
 function requireRole(role, options) {
   return (req, res, next) => __async(null, null, function* () {
-    const requestId = req.headers["x-request-id"] || "unknown";
-    logger.debug("RequireRole middleware invoked", {
-      requestId,
-      path: req.path,
-      requiredRole: role
-    });
     try {
       yield authenticateToken(req, __spreadProps(__spreadValues({}, options), {
         requiredRole: role
       }));
-      logger.debug("RequireRole middleware completed successfully", {
-        requestId,
-        role
-      });
       next();
     } catch (error) {
       logger.error("RequireRole middleware failed", {
-        requestId,
         requiredRole: role,
         error: error instanceof Error ? error.message : "Unknown error"
       });
@@ -447,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;
@@ -505,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();
@@ -524,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}`
@@ -538,7 +520,7 @@ function useCache() {
       }
     });
   }
-  function remove(cacheKey) {
+  function delCache(cacheKey) {
     return __async(this, null, function* () {
       try {
         const redisClient3 = getRedisClient();
@@ -551,7 +533,7 @@ function useCache() {
       }
     });
   }
-  function clearGroup(group) {
+  function delCacheGroup(group) {
     return __async(this, null, function* () {
       try {
         const redisClient3 = getRedisClient();
@@ -567,10 +549,10 @@ function useCache() {
     });
   }
   return {
-    get,
-    set,
-    remove,
-    clearGroup
+    getCache,
+    setCache,
+    delCache,
+    delCacheGroup
   };
 }
 
@@ -815,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* () {