@govish/shared-services 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Version 1.1.0
+
+### Added
+- **StationCacheService**: Redis-based caching service for police stations
+  - Full list as JSON key (`stations`), set of IDs (`stations:all`), per-station hashes (`station:${id}`)
+  - `cacheAllPoliceStations(stations)`, `getStationById`, `getAllStations`, `getStationsList`, `getStationsJson`, `clearCache`, `storePoliceStation`
+
+---
+
 ## Version 1.0.0
 
 ### Added

package/README.md

@@ -28,6 +28,7 @@ const authenticateDeviceOrOfficer = createAuthenticateDeviceOrOfficer(dependenci
 - **OfficerCacheService**: Redis-based caching service for officers with indexing and efficient queries
 - **PenalCodeCacheService**: Redis-based caching service for penal codes
 - **DeviceCacheService**: Redis-based caching service for devices with indexing
+- **StationCacheService**: Redis-based caching service for police stations (JSON list, set of IDs, and per-station hashes)
 - **ApiKeyService**: Service for managing and validating API keys with Redis caching
 - **AuditService**: Service for logging audit events to Kafka with comprehensive event tracking
 - **authenticateDeviceOrOfficer**: Express middleware for authenticating devices, officers, or microservices via API keys

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export { OfficerService } from './services/officerService';
 export { PenalCodeCacheService } from './services/penalCodeCacheService';
 export { DeviceCacheService } from './services/deviceCacheService';
 export { DeviceService } from './services/deviceService';
+export { StationCacheService } from './services/stationCacheService';
 export { ApiKeyService } from './services/apiKeyService';
 export type { ApiKeyData } from './services/apiKeyService';
 export { AuditService } from './services/auditService';

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.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.createSafeRedisUtils = exports.createSafeRedisSet = exports.createSafeRedisGet = exports.createAuthenticateDeviceOrOfficer = exports.AuditEventType = exports.AuditService = exports.ApiKeyService = 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; } });
@@ -12,6 +12,8 @@ var deviceCacheService_1 = require("./services/deviceCacheService");
 Object.defineProperty(exports, "DeviceCacheService", { enumerable: true, get: function () { return deviceCacheService_1.DeviceCacheService; } });
 var deviceService_1 = require("./services/deviceService");
 Object.defineProperty(exports, "DeviceService", { enumerable: true, get: function () { return deviceService_1.DeviceService; } });
+var stationCacheService_1 = require("./services/stationCacheService");
+Object.defineProperty(exports, "StationCacheService", { enumerable: true, get: function () { return stationCacheService_1.StationCacheService; } });
 var apiKeyService_1 = require("./services/apiKeyService");
 Object.defineProperty(exports, "ApiKeyService", { enumerable: true, get: function () { return apiKeyService_1.ApiKeyService; } });
 var auditService_1 = require("./services/auditService");

package/dist/services/stationCacheService.d.ts

@@ -0,0 +1,41 @@
+import { SharedServicesDependencies } from '../types/dependencies';
+export declare class StationCacheService {
+    private redisClient;
+    private logger;
+    constructor(deps: SharedServicesDependencies);
+    /**
+     * Store individual station as Redis hash (for hGetAll lookup).
+     * Nested objects (subCounty, county, region, Officer) are JSON-stringified.
+     */
+    storePoliceStation(station: any): Promise<void>;
+    /**
+     * Get station by ID from cache (O(1) hash lookup).
+     */
+    getStationById(id: number): Promise<any | null>;
+    /**
+     * Get all station IDs from the "stations:all" set.
+     */
+    getAllStationIds(): Promise<number[]>;
+    /**
+     * Get all stations from cache (hashes), sorted by id desc.
+     */
+    getAllStations(): Promise<any[]>;
+    /**
+     * Get the full stations list as JSON string (same as redisClient.get('stations')).
+     * Use when you need the exact payload that was stored by cacheAllPoliceStations.
+     */
+    getStationsJson(): Promise<string | null>;
+    /**
+     * Get parsed stations array from the JSON key (convenience for list API).
+     */
+    getStationsList(): Promise<any[]>;
+    /**
+     * Clear all station-related keys: stations, stations:all, and every station:${id} hash.
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Cache all police stations: clear cache, store full list as JSON, store IDs in set, store each station as hash.
+     * Caller must provide the stations array (e.g. from Prisma or auth API).
+     */
+    cacheAllPoliceStations(stations: any[]): Promise<any[]>;
+}

package/dist/services/stationCacheService.js

@@ -0,0 +1,280 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StationCacheService = void 0;
+/** Redis keys used by this service */
+const KEY_JSON = 'stations';
+const KEY_ALL_IDS = 'stations:all';
+const KEY_STATION_HASH = (id) => `station:${id}`;
+class StationCacheService {
+    constructor(deps) {
+        this.redisClient = deps.redisClient;
+        this.logger = deps.logger;
+    }
+    /**
+     * Store individual station as Redis hash (for hGetAll lookup).
+     * Nested objects (subCounty, county, region, Officer) are JSON-stringified.
+     */
+    storePoliceStation(station) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            try {
+                const key = KEY_STATION_HASH(station.id);
+                const safeDate = (date) => {
+                    if (!date)
+                        return '';
+                    if (date instanceof Date)
+                        return isNaN(date.getTime()) ? '' : date.toISOString();
+                    if (typeof date === 'string')
+                        return date;
+                    return '';
+                };
+                const hashData = {
+                    id: station.id.toString(),
+                    name: (station.name || '').toString(),
+                    station_code: (station.station_code || '').toString(),
+                    subCountyId: ((_b = (_a = station.subCountyId) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : '').toString(),
+                    countyId: ((_d = (_c = station.countyId) === null || _c === void 0 ? void 0 : _c.toString()) !== null && _d !== void 0 ? _d : '').toString(),
+                    regionId: ((_f = (_e = station.regionId) === null || _e === void 0 ? void 0 : _e.toString()) !== null && _f !== void 0 ? _f : '').toString(),
+                    created_at: safeDate(station.created_at),
+                    updated_at: safeDate(station.updated_at),
+                };
+                try {
+                    hashData.subCounty = JSON.stringify((_g = station.subCounty) !== null && _g !== void 0 ? _g : null);
+                }
+                catch (_j) {
+                    hashData.subCounty = 'null';
+                }
+                try {
+                    hashData.Officer = JSON.stringify((_h = station.Officer) !== null && _h !== void 0 ? _h : null);
+                }
+                catch (_k) {
+                    hashData.Officer = 'null';
+                }
+                yield this.redisClient.hSet(key, hashData);
+            }
+            catch (error) {
+                this.logger.error('Error storing station in cache', {
+                    error: error instanceof Error ? error.message : String(error),
+                    stationId: station === null || station === void 0 ? void 0 : station.id,
+                });
+                throw error;
+            }
+        });
+    }
+    /**
+     * Get station by ID from cache (O(1) hash lookup).
+     */
+    getStationById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const raw = yield this.redisClient.hGetAll(KEY_STATION_HASH(id));
+                const data = raw instanceof Map ? Object.fromEntries(raw) : raw;
+                if (!(data === null || data === void 0 ? void 0 : data.id))
+                    return null;
+                const parseJson = (s) => {
+                    if (!s || s === 'null' || s === '"null"')
+                        return null;
+                    try {
+                        return JSON.parse(s);
+                    }
+                    catch (_a) {
+                        return null;
+                    }
+                };
+                return Object.assign(Object.assign({}, data), { id: parseInt(data.id, 10), subCountyId: data.subCountyId ? parseInt(data.subCountyId, 10) : null, countyId: data.countyId ? parseInt(data.countyId, 10) : null, regionId: data.regionId ? parseInt(data.regionId, 10) : null, created_at: data.created_at ? new Date(data.created_at) : null, updated_at: data.updated_at ? new Date(data.updated_at) : null, subCounty: parseJson(data.subCounty), Officer: parseJson(data.Officer) });
+            }
+            catch (error) {
+                this.logger.error('Error getting station from cache', {
+                    error: error instanceof Error ? error.message : String(error),
+                    stationId: id,
+                });
+                return null;
+            }
+        });
+    }
+    /**
+     * Get all station IDs from the "stations:all" set.
+     */
+    getAllStationIds() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const ids = yield this.redisClient.sMembers(KEY_ALL_IDS);
+                return ids.map((id) => parseInt(id, 10)).filter((n) => !Number.isNaN(n));
+            }
+            catch (error) {
+                this.logger.error('Error getting station IDs from cache', {
+                    error: error instanceof Error ? error.message : String(error),
+                });
+                return [];
+            }
+        });
+    }
+    /**
+     * Get all stations from cache (hashes), sorted by id desc.
+     */
+    getAllStations() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const ids = yield this.getAllStationIds();
+                if (ids.length === 0)
+                    return [];
+                const pipeline = this.redisClient.multi();
+                ids.forEach((id) => pipeline.hGetAll(KEY_STATION_HASH(id)));
+                const results = yield pipeline.exec();
+                if (!(results === null || results === void 0 ? void 0 : results.length))
+                    return [];
+                const parseJson = (s) => {
+                    if (!s || s === 'null' || s === '"null"')
+                        return null;
+                    try {
+                        return JSON.parse(s);
+                    }
+                    catch (_a) {
+                        return null;
+                    }
+                };
+                const stations = results
+                    .map((result, index) => {
+                    let raw;
+                    if (Array.isArray(result) && result.length === 2) {
+                        const [err, data] = result;
+                        if (err)
+                            return null;
+                        raw = data;
+                    }
+                    else {
+                        raw = result;
+                    }
+                    const data = raw instanceof Map ? Object.fromEntries(raw) : raw;
+                    if (!(data === null || data === void 0 ? void 0 : data.id))
+                        return null;
+                    return Object.assign(Object.assign({}, data), { id: parseInt(data.id, 10), subCountyId: data.subCountyId ? parseInt(data.subCountyId, 10) : null, countyId: data.countyId ? parseInt(data.countyId, 10) : null, regionId: data.regionId ? parseInt(data.regionId, 10) : null, created_at: data.created_at ? new Date(data.created_at) : null, updated_at: data.updated_at ? new Date(data.updated_at) : null, subCounty: parseJson(data.subCounty), Officer: parseJson(data.Officer) });
+                })
+                    .filter(Boolean);
+                return stations.sort((a, b) => b.id - a.id);
+            }
+            catch (error) {
+                this.logger.error('Error getting all stations from cache', {
+                    error: error instanceof Error ? error.message : String(error),
+                });
+                return [];
+            }
+        });
+    }
+    /**
+     * Get the full stations list as JSON string (same as redisClient.get('stations')).
+     * Use when you need the exact payload that was stored by cacheAllPoliceStations.
+     */
+    getStationsJson() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield this.redisClient.get(KEY_JSON);
+            }
+            catch (error) {
+                this.logger.error('Error getting stations JSON from cache', {
+                    error: error instanceof Error ? error.message : String(error),
+                });
+                return null;
+            }
+        });
+    }
+    /**
+     * Get parsed stations array from the JSON key (convenience for list API).
+     */
+    getStationsList() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const json = yield this.getStationsJson();
+            if (!json)
+                return [];
+            try {
+                const parsed = JSON.parse(json);
+                return Array.isArray(parsed) ? parsed : [];
+            }
+            catch (_a) {
+                return [];
+            }
+        });
+    }
+    /**
+     * Clear all station-related keys: stations, stations:all, and every station:${id} hash.
+     */
+    clearCache() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const ids = yield this.redisClient.sMembers(KEY_ALL_IDS);
+                if (ids.length > 0) {
+                    const pipeline = this.redisClient.multi();
+                    ids.forEach((id) => pipeline.del(KEY_STATION_HASH(parseInt(id, 10))));
+                    yield pipeline.exec();
+                }
+                yield this.redisClient.del(KEY_ALL_IDS);
+                yield this.redisClient.del(KEY_JSON);
+            }
+            catch (error) {
+                this.logger.error('Error clearing station cache', {
+                    error: error instanceof Error ? error.message : String(error),
+                });
+            }
+        });
+    }
+    /**
+     * Cache all police stations: clear cache, store full list as JSON, store IDs in set, store each station as hash.
+     * Caller must provide the stations array (e.g. from Prisma or auth API).
+     */
+    cacheAllPoliceStations(stations) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.clearCache();
+                yield this.redisClient.set(KEY_JSON, JSON.stringify(stations));
+                const stationIds = stations.map((s) => s.id.toString());
+                if (stationIds.length > 0) {
+                    try {
+                        const keyType = yield this.redisClient.type(KEY_ALL_IDS);
+                        if (keyType !== 'set' && keyType !== 'none') {
+                            yield this.redisClient.del(KEY_ALL_IDS);
+                        }
+                    }
+                    catch (_a) {
+                        // ignore
+                    }
+                    yield this.redisClient.sAdd(KEY_ALL_IDS, stationIds);
+                }
+                for (const station of stations) {
+                    yield this.storePoliceStation(station);
+                }
+                if (stations.length > 0) {
+                    const sampleId = stations[0].id;
+                    const sampleHash = yield this.redisClient.hGetAll(KEY_STATION_HASH(sampleId));
+                    if (!sampleHash || !sampleHash.id) {
+                        this.logger.warn('Hash storage verification failed for sample station', { stationId: sampleId });
+                    }
+                }
+                this.logger.info('Police stations cached successfully', {
+                    stationCount: stations.length,
+                    storageTypes: {
+                        json: `${KEY_JSON} (JSON string)`,
+                        hash: `station:\${id} (Redis hash - hGetAll)`,
+                        set: `${KEY_ALL_IDS} (Redis set)`,
+                    },
+                });
+                return stations;
+            }
+            catch (error) {
+                this.logger.error('Error caching police stations', {
+                    error: error instanceof Error ? error.message : String(error),
+                });
+                throw error;
+            }
+        });
+    }
+}
+exports.StationCacheService = StationCacheService;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@govish/shared-services",
-  "version": "1.0.0",
-  "description": "Govish shared services package - includes cache services, API key service, audit logging, and authentication middleware",
+  "version": "1.1.0",
+  "description": "Govish shared services package - includes officer, device, station, and penal code cache services, API key service, audit logging, and authentication middleware",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [