Class BreachDetector

Index

Methods

create start stop getAlerts getStats clearAlerts isActive alert recordQuery recordAuthFailure

Methods

`Static`create

create(prorm: Prorm, options?: BreachDetectorOptions): BreachDetector
Create a new BreachDetector instance
Parameters
- prorm: Prorm
- options: BreachDetectorOptions = {}
Returns BreachDetector
- Defined in compliance/breach-detector.ts:191

start

start(): Promise<void>
Start monitoring queries for breaches

Returns Promise<void>
- Defined in compliance/breach-detector.ts:200

stop

stop(): void
Stop monitoring

Returns void
- Defined in compliance/breach-detector.ts:238

getAlerts

getAlerts(
    options?: {
        severity?: BreachSeverity;
        category?: BreachCategory;
        limit?: number;
    },
): BreachAlert[]
Get all breach alerts
Parameters
- Optionaloptions: { severity?: BreachSeverity; category?: BreachCategory; limit?: number }
Returns BreachAlert[]
- Defined in compliance/breach-detector.ts:556

getStats

getStats(): {
    uptime: number;
    totalQueries: number;
    totalAlerts: number;
    massExportAlerts: number;
    failedAuthAlerts: number;
    rateLimitAlerts: number;
    unusualTimeAlerts: number;
    suspiciousPatternAlerts: number;
    bulkDownloadAlerts: number;
    alertsBySeverity: Record<BreachSeverity, number>;
    alertsByCategory: Record<BreachCategory, number>;
}
Get detection statistics

Returns {
    uptime: number;
    totalQueries: number;
    totalAlerts: number;
    massExportAlerts: number;
    failedAuthAlerts: number;
    rateLimitAlerts: number;
    unusualTimeAlerts: number;
    suspiciousPatternAlerts: number;
    bulkDownloadAlerts: number;
    alertsBySeverity: Record<BreachSeverity, number>;
    alertsByCategory: Record<BreachCategory, number>;
}
- Defined in compliance/breach-detector.ts:579

clearAlerts

clearAlerts(): void
Clear all alerts

Returns void
- Defined in compliance/breach-detector.ts:630

isActive

isActive(): boolean
Check if monitoring is active

Returns boolean
- Defined in compliance/breach-detector.ts:637

alert

alert(options: Omit<BreachAlert, "id" | "timestamp">): void
Manually trigger an alert (for custom checks)
Parameters
- options: Omit<BreachAlert, "id" | "timestamp">
Returns void
- Defined in compliance/breach-detector.ts:644

recordQuery

recordQuery(userId?: string, ipAddress?: string, recordsAffected?: number): void
Record a query execution (for external tracking)
Parameters
- OptionaluserId: string
- OptionalipAddress: string
- OptionalrecordsAffected: number
Returns void
- Defined in compliance/breach-detector.ts:651

recordAuthFailure

recordAuthFailure(userId?: string, ipAddress?: string): void
Record authentication failure
Parameters
- OptionaluserId: string
- OptionalipAddress: string
Returns void
- Defined in compliance/breach-detector.ts:672