@govish/shared-services 1.0.0

package/dist/services/auditService.d.ts

@@ -0,0 +1,109 @@
+import { Request } from 'express';
+import { SharedServicesDependencies } from '../types/dependencies';
+/**
+ * Audit event types
+ */
+export declare enum AuditEventType {
+    LOGIN_SUCCESS = "login_success",
+    LOGIN_FAILED = "login_failed",
+    LOGIN_NOT_PERMITTED = "login_not_permitted",
+    LOGOUT = "logout",
+    TOKEN_GENERATED = "token_generated",
+    OFFICER_RETRIEVED = "officer_retrieved",
+    OFFICERS_LISTED = "officers_listed",
+    DEVICE_RETRIEVED = "device_retrieved",
+    DEVICES_LISTED = "devices_listed",
+    ARREST_CREATED = "arrest_created",
+    ARREST_UPDATED = "arrest_updated",
+    ARREST_DELETED = "arrest_deleted",
+    ARREST_RETRIEVED = "arrest_retrieved",
+    ARRESTS_LISTED = "arrests_listed",
+    ARREST_OB_GENERATED = "arrest_ob_generated",
+    ENDPOINT_ACCESSED = "endpoint_accessed",
+    UNAUTHORIZED_ACCESS = "unauthorized_access",
+    FORBIDDEN_ACCESS = "forbidden_access"
+}
+export interface AuditEventPayload {
+    timestamp: string;
+    microservice: string;
+    event_type: AuditEventType;
+    endpoint: string;
+    method: string;
+    path: string;
+    query_params?: Record<string, any>;
+    request_body?: any;
+    response_status?: number;
+    ip_address?: string;
+    user_agent?: string;
+    user_id?: number;
+    user_type?: 'officer' | 'device' | 'both' | 'api_key' | 'microservice';
+    officer_id?: number;
+    officer_name?: string;
+    officer_service_number?: string;
+    officer_email?: string;
+    device_id?: number;
+    device_device_id?: string;
+    api_key_id?: number;
+    authenticated_microservice?: string;
+    arrest_id?: number;
+    ob_number?: string;
+    sync_id?: any;
+    iprs_id?: number;
+    arresting_officer_id?: number;
+    arresting_station_id?: number;
+    sub_module_id?: number;
+    duration_ms?: number;
+    error_message?: string;
+    error_code?: string;
+    error_stack?: string;
+    [key: string]: any;
+}
+export declare class AuditService {
+    private logger;
+    private kafkaProducer?;
+    private isProducerConnected?;
+    private serverName?;
+    private auditTopic?;
+    private enableDebugLogs;
+    private internalProducer?;
+    private internalKafkaClient?;
+    private isInternalConnection;
+    private connectionAttempted;
+    constructor(deps: SharedServicesDependencies);
+    /**
+     * Initialize internal Kafka connection from brokers
+     */
+    private initializeInternalKafkaConnection;
+    /**
+     * Debug log helper - only logs if debug is enabled
+     */
+    private debugLog;
+    /**
+     * Debug error helper - only logs if debug is enabled
+     */
+    private debugError;
+    /**
+     * Ensure producer is connected (for internal connections)
+     */
+    private ensureConnected;
+    /**
+     * Send audit event to Kafka
+     */
+    logAuditEvent(req: Request, payload: Partial<AuditEventPayload>): Promise<void>;
+    /**
+     * Determine event type based on request path and method
+     */
+    static determineEventType(req: Request): AuditEventType;
+    /**
+     * Log endpoint access (called from middleware)
+     */
+    logEndpointAccess(req: Request): Promise<void>;
+    /**
+     * Log endpoint access with response status
+     */
+    logEndpointAccessWithResponse(req: Request, res: any, startTime: number): Promise<void>;
+    /**
+     * Extract and add arrest-specific information to audit payload
+     */
+    addArrestInformation(req: Request, auditPayload: AuditEventPayload, payload: Partial<AuditEventPayload>): void;
+}