@govish/shared-services 1.4.0 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## Version 1.6.0
+
+### Added
+- **Rolling cache utilities** (`createRollingCache`): list/item pattern with `buildKey`, `get`, `set`, `getOrSet`, `invalidate`, `invalidateByPrefix`, `recordAccess` (Redis `ZINCRBY` for hot-key telemetry), and default TTL helpers from `CACHE_DAYS_LIST` / `CACHE_DAYS_ITEM`. Opt-in via `ROLLING_CACHE_ENABLED` / `CACHE_ENABLED`. Uses the host `redisClient` for `setEx`, `del`, `scan`, and sorted sets.
+
+---
+
+## Version 1.5.1
+
+### Fixed
+- **AuditService**: Fixed `microservice` field in audit logs to always use the receiving service name from `SERVER_NAME` environment variable instead of the API key's microservice. The `source_microservice` and `authenticated_microservice` fields now correctly contain the API key's microservice information.
+
+---
+
 ## Version 1.4.0
 
 ### Changed

package/README.md

@@ -37,6 +37,7 @@ const authenticateDeviceOrOfficer = createAuthenticateDeviceOrOfficer(dependenci
 
 ## Utilities Included
 
+- **createRollingCache**: List/item rolling cache (`buildKey`, `get`, `set`, `getOrSet`, `invalidate`, `invalidateByPrefix`, `recordAccess`) with day-based TTL from `CACHE_DAYS_LIST` / `CACHE_DAYS_ITEM`; enable with `ROLLING_CACHE_ENABLED=true`
 - **createSafeRedisGet**: Factory function to create a safe Redis GET operation with automatic reconnection
 - **createSafeRedisSet**: Factory function to create a safe Redis SET operation with automatic reconnection
 - **createSafeRedisUtils**: Factory function that creates both safeRedisGet and safeRedisSet functions
@@ -65,7 +66,7 @@ import {
   ApiKeyService,
   createAuthenticateDeviceOrOfficer,
   SharedServicesDependencies 
-} from '@ob-main/shared-services';
+} from '@govish/shared-services';
 import { redisClient } from './app';
 import { logger } from './utils/logger';
 // ... other dependencies

package/dist/index.d.ts

@@ -13,6 +13,8 @@ export { AuditEventType } from './services/auditService';
 export type { AuditEventPayload } from './services/auditService';
 export { createAuthenticateDeviceOrOfficer } from './middleware/authenticateDevice';
 export { createSafeRedisGet, createSafeRedisSet, createSafeRedisUtils } from './utils/redis';
+export { createRollingCache, ROLLING_CACHE_SEP, } from './utils/rollingCache';
+export type { RollingCacheInstance, RollingCacheOptions, RollingCacheTtl, } from './utils/rollingCache';
 export { getEnvironmentMode, isDevelopmentMode, isProductionMode, devLog, devError, devWarn, devDebug } from './utils/logMode';
 export type { EnvironmentMode } from './utils/logMode';
 export type { SharedServicesDependencies } from './types/dependencies';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.devDebug = exports.devWarn = exports.devError = exports.devLog = exports.isProductionMode = exports.isDevelopmentMode = exports.getEnvironmentMode = exports.createSafeRedisUtils = exports.createSafeRedisSet = exports.createSafeRedisGet = exports.createAuthenticateDeviceOrOfficer = exports.AuditEventType = exports.AuditService = exports.ApiKeyService = exports.RankLeaveDaysCacheService = exports.StationDutyBlockCacheService = exports.StationCacheService = exports.DeviceService = exports.DeviceCacheService = exports.PenalCodeCacheService = exports.OfficerService = exports.OfficerCacheService = void 0;
+exports.devDebug = exports.devWarn = exports.devError = exports.devLog = exports.isProductionMode = exports.isDevelopmentMode = exports.getEnvironmentMode = exports.ROLLING_CACHE_SEP = exports.createRollingCache = exports.createSafeRedisUtils = exports.createSafeRedisSet = exports.createSafeRedisGet = exports.createAuthenticateDeviceOrOfficer = exports.AuditEventType = exports.AuditService = exports.ApiKeyService = exports.RankLeaveDaysCacheService = exports.StationDutyBlockCacheService = exports.StationCacheService = exports.DeviceService = exports.DeviceCacheService = exports.PenalCodeCacheService = exports.OfficerService = exports.OfficerCacheService = void 0;
 // Export services
 var officerCacheService_1 = require("./services/officerCacheService");
 Object.defineProperty(exports, "OfficerCacheService", { enumerable: true, get: function () { return officerCacheService_1.OfficerCacheService; } });
@@ -32,6 +32,9 @@ var redis_1 = require("./utils/redis");
 Object.defineProperty(exports, "createSafeRedisGet", { enumerable: true, get: function () { return redis_1.createSafeRedisGet; } });
 Object.defineProperty(exports, "createSafeRedisSet", { enumerable: true, get: function () { return redis_1.createSafeRedisSet; } });
 Object.defineProperty(exports, "createSafeRedisUtils", { enumerable: true, get: function () { return redis_1.createSafeRedisUtils; } });
+var rollingCache_1 = require("./utils/rollingCache");
+Object.defineProperty(exports, "createRollingCache", { enumerable: true, get: function () { return rollingCache_1.createRollingCache; } });
+Object.defineProperty(exports, "ROLLING_CACHE_SEP", { enumerable: true, get: function () { return rollingCache_1.ROLLING_CACHE_SEP; } });
 var logMode_1 = require("./utils/logMode");
 Object.defineProperty(exports, "getEnvironmentMode", { enumerable: true, get: function () { return logMode_1.getEnvironmentMode; } });
 Object.defineProperty(exports, "isDevelopmentMode", { enumerable: true, get: function () { return logMode_1.isDevelopmentMode; } });

package/dist/middleware/authenticateDevice.d.ts

@@ -1,7 +1,7 @@
 import { Request, Response, NextFunction } from 'express';
 import { SharedServicesDependencies } from '../types/dependencies';
 /**
- * Middleware to authenticate either a device, an officer, or a microservice (via API key)
+ * Middleware to authenticate either a device, an officer, a microservice (via API key), or combinations thereof
  * Checks JWT token and validates against Device or Officer table
  * Also checks for API keys for microservice authentication
  *
@@ -10,6 +10,17 @@ import { SharedServicesDependencies } from '../types/dependencies';
  * - Device-Token: <device_jwt_token> (for device authentication)
  * - Authorization: Bearer <user_jwt_token> (for officer/user authentication)
  *
- * Priority: API Key > Device Token > Authorization Token
+ * Supports combined authentication:
+ * - API Key + Officer: X-API-Key + Authorization header (sets authType: 'api_key_and_officer')
+ * - Device + Officer: Device-Token + Authorization header (sets authType: 'both')
+ *
+ * Authentication Priority/Combination Logic:
+ * 1. API Key + Officer (if both headers present) -> authType: 'api_key_and_officer'
+ * 2. API Key only (if only X-API-Key present) -> authType: 'api_key'
+ * 3. Device + Officer (if both headers present) -> authType: 'both'
+ * 4. Device only (if only Device-Token present) -> authType: 'device'
+ * 5. Officer only (if only Authorization present) -> authType: 'officer'
+ *
+ * At least one authentication method must succeed for the request to proceed.
  */
 export declare const createAuthenticateDeviceOrOfficer: (deps: SharedServicesDependencies) => (req: Request, res: Response, next: NextFunction) => Promise<void | Response<any, Record<string, any>>>;