driftdetect-core 0.1.0

package/dist/config/config-validator.d.ts

@@ -0,0 +1,204 @@
+/**
+ * Config Validator - Configuration validation against JSON schema
+ *
+ * Provides comprehensive validation for DriftConfig objects with
+ * helpful, actionable error messages for invalid configurations.
+ *
+ * @requirements 36.6 - Configuration validation SHALL reject invalid values with helpful error messages
+ * @requirements 36.7 - Configuration SHALL support JSON schema validation
+ */
+import type { DriftConfig } from './types.js';
+/**
+ * Represents a single configuration validation error
+ */
+export interface ConfigValidationError {
+    /** Path to the invalid field (e.g., 'ai.provider', 'learning.autoApproveThreshold') */
+    path: string;
+    /** Human-readable error message */
+    message: string;
+    /** Expected value or type */
+    expected?: string;
+    /** Actual value received */
+    actual?: unknown;
+    /** Suggestion for how to fix the error */
+    suggestion?: string;
+}
+/**
+ * Result of a configuration validation operation
+ */
+export interface ConfigValidationResult {
+    /** Whether validation passed */
+    valid: boolean;
+    /** Validated and typed data (only present if valid) */
+    data?: DriftConfig;
+    /** List of validation errors (only present if invalid) */
+    errors?: ConfigValidationError[];
+}
+/**
+ * Custom error class for configuration validation failures
+ *
+ * @requirements 36.6 - Provide helpful error messages
+ */
+export declare class ConfigValidationException extends Error {
+    readonly errors: ConfigValidationError[];
+    constructor(message: string, errors: ConfigValidationError[]);
+    /**
+     * Format errors as a human-readable string with suggestions
+     */
+    formatErrors(): string;
+    /**
+     * Get a summary of all errors
+     */
+    getSummary(): string;
+}
+/**
+ * Validate a DriftConfig object against the JSON schema
+ *
+ * @requirements 36.6 - Configuration validation SHALL reject invalid values with helpful error messages
+ * @requirements 36.7 - Configuration SHALL support JSON schema validation
+ *
+ * @param data - The data to validate
+ * @returns Validation result with typed data or errors
+ */
+export declare function validateConfig(data: unknown): ConfigValidationResult;
+/**
+ * Validate a DriftConfig and throw if invalid
+ *
+ * @requirements 36.6 - Configuration validation SHALL reject invalid values with helpful error messages
+ * @requirements 36.7 - Configuration SHALL support JSON schema validation
+ *
+ * @param data - The data to validate
+ * @returns The validated DriftConfig
+ * @throws ConfigValidationException if validation fails
+ */
+export declare function assertValidConfig(data: unknown): DriftConfig;
+/**
+ * Validate a partial DriftConfig (for merging with defaults)
+ *
+ * This is more lenient than full validation - it allows missing required fields
+ * since they will be filled in from defaults.
+ *
+ * @requirements 36.6 - Configuration validation SHALL reject invalid values with helpful error messages
+ * @requirements 36.7 - Configuration SHALL support JSON schema validation
+ *
+ * @param data - The partial data to validate
+ * @returns Validation result with typed data or errors
+ */
+export declare function validatePartialConfig(data: unknown): ConfigValidationResult;
+/**
+ * Format validation errors as a human-readable string
+ *
+ * @requirements 36.6 - Provide helpful error messages
+ *
+ * @param errors - Array of validation errors
+ * @returns Formatted error string
+ */
+export declare function formatConfigErrors(errors: ConfigValidationError[]): string;
+/**
+ * Get a quick summary of validation errors
+ *
+ * @param errors - Array of validation errors
+ * @returns Short summary string
+ */
+export declare function getErrorSummary(errors: ConfigValidationError[]): string;
+/**
+ * JSON Schema definition for DriftConfig
+ *
+ * This can be used by external tools for validation or IDE support.
+ *
+ * @requirements 36.7 - Configuration SHALL support JSON schema validation
+ */
+export declare const DRIFT_CONFIG_SCHEMA: {
+    readonly $schema: "http://json-schema.org/draft-07/schema#";
+    readonly title: "DriftConfig";
+    readonly description: "Configuration schema for Drift architectural drift detection";
+    readonly type: "object";
+    readonly properties: {
+        readonly severity: {
+            readonly type: "object";
+            readonly description: "Severity overrides per pattern ID";
+            readonly additionalProperties: {
+                readonly type: "string";
+                readonly enum: readonly ["error", "warning", "info", "hint"];
+            };
+        };
+        readonly ignore: {
+            readonly type: "array";
+            readonly description: "File/folder patterns to ignore";
+            readonly items: {
+                readonly type: "string";
+                readonly minLength: 1;
+            };
+        };
+        readonly ai: {
+            readonly type: "object";
+            readonly description: "AI provider configuration (BYOK)";
+            readonly properties: {
+                readonly provider: {
+                    readonly type: "string";
+                    readonly enum: readonly ["openai", "anthropic", "ollama"];
+                    readonly description: "AI provider to use";
+                };
+                readonly model: {
+                    readonly type: "string";
+                    readonly description: "Model name to use";
+                };
+            };
+            readonly required: readonly ["provider"];
+        };
+        readonly ci: {
+            readonly type: "object";
+            readonly description: "CI/CD mode settings";
+            readonly properties: {
+                readonly failOn: {
+                    readonly type: "string";
+                    readonly enum: readonly ["error", "warning", "none"];
+                    readonly description: "Severity level that causes CI failure";
+                };
+                readonly reportFormat: {
+                    readonly type: "string";
+                    readonly enum: readonly ["json", "text", "github", "gitlab"];
+                    readonly description: "Output format for CI reports";
+                };
+            };
+        };
+        readonly learning: {
+            readonly type: "object";
+            readonly description: "Pattern learning settings";
+            readonly properties: {
+                readonly autoApproveThreshold: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 1;
+                    readonly description: "Confidence threshold for auto-approving patterns";
+                };
+                readonly minOccurrences: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly description: "Minimum occurrences to detect a pattern";
+                };
+            };
+        };
+        readonly performance: {
+            readonly type: "object";
+            readonly description: "Performance tuning settings";
+            readonly properties: {
+                readonly maxWorkers: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly description: "Maximum worker threads for parallel processing";
+                };
+                readonly cacheEnabled: {
+                    readonly type: "boolean";
+                    readonly description: "Enable analysis caching";
+                };
+                readonly incrementalAnalysis: {
+                    readonly type: "boolean";
+                    readonly description: "Enable incremental analysis for changed files";
+                };
+            };
+        };
+    };
+    readonly additionalProperties: false;
+};
+//# sourceMappingURL=config-validator.d.ts.map

package/dist/config/config-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-validator.d.ts","sourceRoot":"","sources":["../../src/config/config-validator.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EACV,WAAW,EACZ,MAAM,YAAY,CAAC;AAuBpB;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,gCAAgC;IAChC,KAAK,EAAE,OAAO,CAAC;IACf,uDAAuD;IACvD,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAClC;AAED;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,KAAK;aAGhC,MAAM,EAAE,qBAAqB,EAAE;gBAD/C,OAAO,EAAE,MAAM,EACC,MAAM,EAAE,qBAAqB,EAAE;IAMjD;;OAEG;IACH,YAAY,IAAI,MAAM;IActB;;OAEG;IACH,UAAU,IAAI,MAAM;CAKrB;AA6YD;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,sBAAsB,CA0CpE;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,WAAW,CAW5D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,OAAO,GAAG,sBAAsB,CAI3E;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAe1E;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAOvE;AAMD;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4FtB,CAAC"}