driftdetect-core 0.1.0

package/dist/store/history-store.d.ts

@@ -0,0 +1,314 @@
+/**
+ * History Store - Pattern change tracking and approval history
+ *
+ * Tracks pattern changes over time and stores approval history.
+ * History entries are stored in .drift/history/ directory.
+ *
+ * @requirements 4.4 - THE Pattern_Store SHALL maintain history of pattern changes in .drift/history/
+ */
+import { EventEmitter } from 'node:events';
+import type { PatternCategory, PatternHistoryEvent, PatternHistory, HistoryEventType, Pattern } from './types.js';
+/**
+ * Error thrown when a history operation fails
+ */
+export declare class HistoryStoreError extends Error {
+    readonly errorCause: Error | undefined;
+    constructor(message: string, errorCause?: Error);
+}
+/**
+ * Error thrown when a pattern history is not found
+ */
+export declare class PatternHistoryNotFoundError extends Error {
+    readonly patternId: string;
+    constructor(patternId: string);
+}
+/**
+ * Configuration options for the history store
+ */
+export interface HistoryStoreConfig {
+    /** Root directory for .drift folder (defaults to project root) */
+    rootDir: string;
+    /** Maximum number of history entries per pattern */
+    maxEntriesPerPattern: number;
+    /** Maximum age for history entries in days */
+    maxAgeDays: number;
+    /** Whether to auto-save changes */
+    autoSave: boolean;
+    /** Debounce time for auto-save in milliseconds */
+    autoSaveDebounce: number;
+}
+/**
+ * Default history store configuration
+ */
+export declare const DEFAULT_HISTORY_STORE_CONFIG: HistoryStoreConfig;
+/**
+ * Query options for filtering history events
+ */
+export interface HistoryQuery {
+    /** Filter by pattern ID */
+    patternId?: string;
+    /** Filter by pattern IDs */
+    patternIds?: string[];
+    /** Filter by event type */
+    eventType?: HistoryEventType | HistoryEventType[];
+    /** Filter by category */
+    category?: PatternCategory | PatternCategory[];
+    /** Filter by user */
+    user?: string;
+    /** Filter events after this date (ISO string) */
+    after?: string;
+    /** Filter events before this date (ISO string) */
+    before?: string;
+    /** Maximum number of results */
+    limit?: number;
+    /** Number of results to skip */
+    offset?: number;
+}
+/**
+ * Result of a history query
+ */
+export interface HistoryQueryResult {
+    /** Matching history events */
+    events: PatternHistoryEvent[];
+    /** Total count (before pagination) */
+    total: number;
+    /** Whether there are more results */
+    hasMore: boolean;
+    /** Query execution time in milliseconds */
+    executionTime: number;
+}
+/**
+ * Events emitted by the history store
+ */
+export type HistoryStoreEventType = 'event:recorded' | 'history:pruned' | 'file:loaded' | 'file:saved' | 'error';
+/**
+ * Event payload for history store events
+ */
+export interface HistoryStoreEvent {
+    /** Event type */
+    type: HistoryStoreEventType;
+    /** Pattern ID (if applicable) */
+    patternId?: string;
+    /** Additional event data */
+    data?: Record<string, unknown>;
+    /** ISO timestamp of the event */
+    timestamp: string;
+}
+/**
+ * History Store - Manages pattern change history
+ *
+ * Tracks all pattern changes including:
+ * - Pattern created
+ * - Pattern updated
+ * - Pattern approved
+ * - Pattern ignored
+ * - Pattern deleted
+ * - Confidence changed
+ * - Locations changed
+ * - Severity changed
+ *
+ * History is stored in .drift/history/patterns.json
+ *
+ * @requirements 4.4 - Pattern history tracked in .drift/history/
+ */
+export declare class HistoryStore extends EventEmitter {
+    private readonly config;
+    private readonly historyDir;
+    private readonly historyFilePath;
+    private histories;
+    private loaded;
+    private dirty;
+    private saveTimeout;
+    constructor(config?: Partial<HistoryStoreConfig>);
+    /**
+     * Initialize the history store
+     *
+     * Creates necessary directories and loads existing history.
+     */
+    initialize(): Promise<void>;
+    /**
+     * Load history from disk
+     *
+     * @requirements 4.4 - Load history from .drift/history/
+     */
+    load(): Promise<void>;
+    /**
+     * Save history to disk
+     *
+     * @requirements 4.4 - Persist history in .drift/history/
+     */
+    save(): Promise<void>;
+    /**
+     * Schedule an auto-save if enabled
+     */
+    private scheduleAutoSave;
+    /**
+     * Record a history event for a pattern
+     *
+     * @param patternId - Pattern ID
+     * @param category - Pattern category
+     * @param eventType - Type of event
+     * @param options - Additional event options
+     */
+    recordEvent(patternId: string, category: PatternCategory, eventType: HistoryEventType, options?: {
+        user?: string;
+        previousValue?: unknown;
+        newValue?: unknown;
+        details?: Record<string, unknown>;
+    }): PatternHistoryEvent;
+    /**
+     * Record a pattern creation event
+     */
+    recordCreated(pattern: Pattern, user?: string): PatternHistoryEvent;
+    /**
+     * Record a pattern update event
+     */
+    recordUpdated(pattern: Pattern, previousPattern: Pattern, user?: string): PatternHistoryEvent;
+    /**
+     * Record a pattern approval event
+     */
+    recordApproved(pattern: Pattern, user?: string): PatternHistoryEvent;
+    /**
+     * Record a pattern ignore event
+     */
+    recordIgnored(pattern: Pattern, user?: string): PatternHistoryEvent;
+    /**
+     * Record a pattern deletion event
+     */
+    recordDeleted(pattern: Pattern, user?: string): PatternHistoryEvent;
+    /**
+     * Record a confidence change event
+     */
+    recordConfidenceChanged(pattern: Pattern, previousScore: number, user?: string): PatternHistoryEvent;
+    /**
+     * Record a locations change event
+     */
+    recordLocationsChanged(pattern: Pattern, previousCount: number, user?: string): PatternHistoryEvent;
+    /**
+     * Record a severity change event
+     */
+    recordSeverityChanged(pattern: Pattern, previousSeverity: string, user?: string): PatternHistoryEvent;
+    /**
+     * Get history for a specific pattern
+     *
+     * @param patternId - Pattern ID
+     * @returns Pattern history or undefined if not found
+     */
+    getPatternHistory(patternId: string): PatternHistory | undefined;
+    /**
+     * Get history for a specific pattern, throwing if not found
+     *
+     * @param patternId - Pattern ID
+     * @returns Pattern history
+     * @throws PatternHistoryNotFoundError if not found
+     */
+    getPatternHistoryOrThrow(patternId: string): PatternHistory;
+    /**
+     * Check if history exists for a pattern
+     *
+     * @param patternId - Pattern ID
+     * @returns True if history exists
+     */
+    hasPatternHistory(patternId: string): boolean;
+    /**
+     * Query history events with filtering and pagination
+     *
+     * @param query - Query options
+     * @returns Query result with matching events
+     */
+    query(query?: HistoryQuery): HistoryQueryResult;
+    /**
+     * Apply filters to events
+     */
+    private applyFilters;
+    /**
+     * Get all history events
+     */
+    getAllEvents(): PatternHistoryEvent[];
+    /**
+     * Get events by type
+     */
+    getEventsByType(eventType: HistoryEventType): PatternHistoryEvent[];
+    /**
+     * Get events by category
+     */
+    getEventsByCategory(category: PatternCategory): PatternHistoryEvent[];
+    /**
+     * Get events in date range
+     */
+    getEventsInDateRange(after: string, before: string): PatternHistoryEvent[];
+    /**
+     * Get recent events
+     *
+     * @param limit - Maximum number of events to return
+     */
+    getRecentEvents(limit?: number): PatternHistoryEvent[];
+    /**
+     * Get approval history
+     */
+    getApprovalHistory(): PatternHistoryEvent[];
+    /**
+     * Get events by user
+     */
+    getEventsByUser(user: string): PatternHistoryEvent[];
+    /**
+     * Prune history for a specific pattern
+     *
+     * Removes old entries based on maxEntriesPerPattern and maxAgeDays config.
+     *
+     * @param patternId - Pattern ID to prune
+     */
+    private prunePatternHistory;
+    /**
+     * Prune all history
+     *
+     * Removes old entries based on maxEntriesPerPattern and maxAgeDays config.
+     */
+    prune(): void;
+    /**
+     * Delete history for a specific pattern
+     *
+     * @param patternId - Pattern ID
+     * @returns True if history was deleted
+     */
+    deletePatternHistory(patternId: string): boolean;
+    /**
+     * Get statistics about the history store
+     */
+    getStats(): {
+        totalPatterns: number;
+        totalEvents: number;
+        eventsByType: Record<HistoryEventType, number>;
+        oldestEvent: string | null;
+        newestEvent: string | null;
+    };
+    /**
+     * Emit a history store event
+     */
+    private emitEvent;
+    /**
+     * Get the number of patterns with history
+     */
+    get size(): number;
+    /**
+     * Check if the store has been loaded
+     */
+    get isLoaded(): boolean;
+    /**
+     * Check if there are unsaved changes
+     */
+    get isDirty(): boolean;
+    /**
+     * Get the history directory path
+     */
+    get path(): string;
+    /**
+     * Clear all history from memory (does not affect disk)
+     */
+    clear(): void;
+    /**
+     * Dispose of the history store
+     */
+    dispose(): void;
+}
+//# sourceMappingURL=history-store.d.ts.map

package/dist/store/history-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"history-store.d.ts","sourceRoot":"","sources":["../../src/store/history-store.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,KAAK,EACV,eAAe,EACf,mBAAmB,EACnB,cAAc,EAEd,gBAAgB,EAChB,OAAO,EACR,MAAM,YAAY,CAAC;AA2BpB;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,SAAgB,UAAU,EAAE,KAAK,GAAG,SAAS,CAAC;gBAElC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,KAAK;CAKhD;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,KAAK;aACxB,SAAS,EAAE,MAAM;gBAAjB,SAAS,EAAE,MAAM;CAI9C;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,kEAAkE;IAClE,OAAO,EAAE,MAAM,CAAC;IAEhB,oDAAoD;IACpD,oBAAoB,EAAE,MAAM,CAAC;IAE7B,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IAEnB,mCAAmC;IACnC,QAAQ,EAAE,OAAO,CAAC;IAElB,kDAAkD;IAClD,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,eAAO,MAAM,4BAA4B,EAAE,kBAM1C,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,2BAA2B;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4BAA4B;IAC5B,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB,2BAA2B;IAC3B,SAAS,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,CAAC;IAElD,yBAAyB;IACzB,QAAQ,CAAC,EAAE,eAAe,GAAG,eAAe,EAAE,CAAC;IAE/C,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,iDAAiD;IACjD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,kDAAkD;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,8BAA8B;IAC9B,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAE9B,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IAEd,qCAAqC;IACrC,OAAO,EAAE,OAAO,CAAC;IAEjB,2CAA2C;IAC3C,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,gBAAgB,GAChB,gBAAgB,GAChB,aAAa,GACb,YAAY,GACZ,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iBAAiB;IACjB,IAAI,EAAE,qBAAqB,CAAC;IAE5B,iCAAiC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;CACnB;AA6BD;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,SAAS,CAA0C;IAC3D,OAAO,CAAC,MAAM,CAAkB;IAChC,OAAO,CAAC,KAAK,CAAkB;IAC/B,OAAO,CAAC,WAAW,CAA+B;gBAEtC,MAAM,GAAE,OAAO,CAAC,kBAAkB,CAAM;IAWpD;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAcjC;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAiC3B;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAiB3B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAoBxB;;;;;;;OAOG;IACH,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,gBAAgB,EAC3B,OAAO,GAAE;QACP,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC9B,GACL,mBAAmB;IAyCtB;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,mBAAmB;IAkBnE;;OAEG;IACH,aAAa,CACX,OAAO,EAAE,OAAO,EAChB,eAAe,EAAE,OAAO,EACxB,IAAI,CAAC,EAAE,MAAM,GACZ,mBAAmB;IAqBtB;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,mBAAmB;IAgBpE;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,mBAAmB;IAQnE;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,mBAAmB;IAgBnE;;OAEG;IACH,uBAAuB,CACrB,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,MAAM,EACrB,IAAI,CAAC,EAAE,MAAM,GACZ,mBAAmB;IAetB;;OAEG;IACH,sBAAsB,CACpB,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,MAAM,EACrB,IAAI,CAAC,EAAE,MAAM,GACZ,mBAAmB;IAoBtB;;OAEG;IACH,qBAAqB,CACnB,OAAO,EAAE,OAAO,EAChB,gBAAgB,EAAE,MAAM,EACxB,IAAI,CAAC,EAAE,MAAM,GACZ,mBAAmB;IAmBtB;;;;;OAKG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAIhE;;;;;;OAMG;IACH,wBAAwB,CAAC,SAAS,EAAE,MAAM,GAAG,cAAc;IAQ3D;;;;;OAKG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAI7C;;;;;OAKG;IACH,KAAK,CAAC,KAAK,GAAE,YAAiB,GAAG,kBAAkB;IAmDnD;;OAEG;IACH,OAAO,CAAC,YAAY;IAwDpB;;OAEG;IACH,YAAY,IAAI,mBAAmB,EAAE;IAIrC;;OAEG;IACH,eAAe,CAAC,SAAS,EAAE,gBAAgB,GAAG,mBAAmB,EAAE;IAInE;;OAEG;IACH,mBAAmB,CAAC,QAAQ,EAAE,eAAe,GAAG,mBAAmB,EAAE;IAIrE;;OAEG;IACH,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,mBAAmB,EAAE;IAI1E;;;;OAIG;IACH,eAAe,CAAC,KAAK,GAAE,MAAW,GAAG,mBAAmB,EAAE;IAI1D;;OAEG;IACH,kBAAkB,IAAI,mBAAmB,EAAE;IAI3C;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,EAAE;IAQpD;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;IA0B3B;;;;OAIG;IACH,KAAK,IAAI,IAAI;IAiBb;;;;;OAKG;IACH,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAahD;;OAEG;IACH,QAAQ,IAAI;QACV,aAAa,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,EAAE,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;QAC/C,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IA2CD;;OAEG;IACH,OAAO,CAAC,SAAS;IAyBjB;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,KAAK,IAAI,IAAI;IAKb;;OAEG;IACH,OAAO,IAAI,IAAI;CAOhB"}