driftdetect-detectors 0.1.0

package/dist/api/error-format.d.ts

@@ -0,0 +1,140 @@
+/**
+ * Error Format Detector - Error response format pattern detection
+ *
+ * Detects error response format patterns including:
+ * - Standard error format ({ error: { message, code, details } })
+ * - HTTP Problem Details (RFC 7807) ({ type, title, status, detail, instance })
+ * - JSON:API error format ({ errors: [{ status, title, detail, source }] })
+ * - GraphQL error format ({ errors: [{ message, locations, path, extensions }] })
+ * - Custom error formats with code/message patterns
+ * - Error inheritance patterns (AppError, HttpError, etc.)
+ *
+ * Flags violations:
+ * - Inconsistent error format across endpoints
+ * - Missing required error fields (message, code)
+ * - Mixing different error formats
+ * - Raw error strings instead of structured errors
+ * - Missing error codes for categorization
+ * - Inconsistent error code naming conventions
+ *
+ * @requirements 10.4 - THE API_Detector SHALL detect error response format consistency
+ */
+import type { Language } from 'driftdetect-core';
+import { RegexDetector, type DetectionContext, type DetectionResult } from '../base/index.js';
+/** Types of error formats detected */
+export type ErrorFormat = 'standard' | 'problem-details' | 'json-api' | 'graphql' | 'simple' | 'custom';
+/** Types of error format patterns detected */
+export type ErrorFormatPatternType = 'error-object' | 'error-array' | 'error-class' | 'error-throw' | 'error-response' | 'error-catch';
+/** Types of error format violations detected */
+export type ErrorFormatViolationType = 'inconsistent-format' | 'missing-message' | 'missing-code' | 'raw-error-string' | 'mixed-formats' | 'inconsistent-codes' | 'missing-status' | 'generic-error';
+/** Information about a detected error format pattern */
+export interface ErrorFormatPatternInfo {
+    type: ErrorFormatPatternType;
+    format: ErrorFormat;
+    file: string;
+    line: number;
+    column: number;
+    matchedText: string;
+    fields?: string[] | undefined;
+    errorCode?: string | undefined;
+    errorClass?: string | undefined;
+    context?: string | undefined;
+}
+/** Information about a detected error format violation */
+export interface ErrorFormatViolationInfo {
+    type: ErrorFormatViolationType;
+    file: string;
+    line: number;
+    column: number;
+    endLine: number;
+    endColumn: number;
+    value: string;
+    issue: string;
+    suggestedFix?: string | undefined;
+    lineContent: string;
+}
+/** Analysis of error format patterns in a file */
+export interface ErrorFormatAnalysis {
+    errorPatterns: ErrorFormatPatternInfo[];
+    violations: ErrorFormatViolationInfo[];
+    dominantFormat: ErrorFormat | null;
+    usesConsistentFormat: boolean;
+    errorCodes: string[];
+    errorClasses: string[];
+    patternAdherenceConfidence: number;
+}
+/** Standard error fields */
+export declare const STANDARD_ERROR_FIELDS: {
+    readonly message: readonly ["message", "msg", "errorMessage", "description"];
+    readonly code: readonly ["code", "errorCode", "error_code", "statusCode", "status_code"];
+    readonly details: readonly ["details", "detail", "data", "metadata", "context", "info"];
+    readonly stack: readonly ["stack", "stackTrace", "trace"];
+};
+/** RFC 7807 Problem Details fields */
+export declare const PROBLEM_DETAILS_FIELDS: readonly ["type", "title", "status", "detail", "instance"];
+/** JSON:API error fields */
+export declare const JSON_API_ERROR_FIELDS: readonly ["status", "title", "detail", "source", "code", "meta", "links"];
+/** GraphQL error fields */
+export declare const GRAPHQL_ERROR_FIELDS: readonly ["message", "locations", "path", "extensions"];
+/** Common error code patterns */
+export declare const ERROR_CODE_PATTERNS: {
+    readonly screaming_snake: RegExp;
+    readonly camelCase: RegExp;
+    readonly kebab: RegExp;
+    readonly dotted: RegExp;
+    readonly prefixed: RegExp;
+};
+/** Common error class names */
+export declare const ERROR_CLASS_PATTERNS: readonly [RegExp, RegExp];
+/** Error response patterns */
+export declare const ERROR_RESPONSE_PATTERNS: readonly [RegExp, RegExp, RegExp, RegExp];
+/** Error throw patterns */
+export declare const ERROR_THROW_PATTERNS: readonly [RegExp, RegExp, RegExp, RegExp];
+/** Error catch patterns */
+export declare const ERROR_CATCH_PATTERNS: readonly [RegExp, RegExp];
+/** File patterns to exclude */
+export declare const EXCLUDED_FILE_PATTERNS: RegExp[];
+/** Check if a file should be excluded from detection */
+export declare function shouldExcludeFile(filePath: string): boolean;
+/** Extract field names from an object literal string */
+export declare function extractFieldNames(objectContent: string): string[];
+/** Detect the error format from fields */
+export declare function detectErrorFormat(fields: string[]): ErrorFormat;
+/** Detect error code naming convention */
+export declare function detectErrorCodeConvention(code: string): string | null;
+/** Check if a string looks like an error code */
+export declare function isErrorCode(value: string): boolean;
+/** Detect error object patterns */
+export declare function detectErrorObjects(content: string, file: string): ErrorFormatPatternInfo[];
+/** Detect error class definitions */
+export declare function detectErrorClasses(content: string, file: string): ErrorFormatPatternInfo[];
+/** Detect error throw patterns */
+export declare function detectErrorThrows(content: string, file: string): ErrorFormatPatternInfo[];
+/** Detect error response patterns in API handlers */
+export declare function detectErrorResponses(content: string, file: string): ErrorFormatPatternInfo[];
+/** Detect inconsistent error format violations */
+export declare function detectInconsistentFormatViolations(patterns: ErrorFormatPatternInfo[], file: string): ErrorFormatViolationInfo[];
+/** Detect missing required field violations */
+export declare function detectMissingFieldViolations(patterns: ErrorFormatPatternInfo[], file: string): ErrorFormatViolationInfo[];
+/** Detect raw error string violations */
+export declare function detectRawErrorStringViolations(content: string, file: string): ErrorFormatViolationInfo[];
+/** Detect generic Error usage violations */
+export declare function detectGenericErrorViolations(patterns: ErrorFormatPatternInfo[], file: string): ErrorFormatViolationInfo[];
+/** Detect inconsistent error code naming violations */
+export declare function detectInconsistentCodeViolations(patterns: ErrorFormatPatternInfo[], file: string): ErrorFormatViolationInfo[];
+/** Analyze error format patterns in file content */
+export declare function analyzeErrorFormat(content: string, file: string): ErrorFormatAnalysis;
+/** Error Format Detector - Detects error response format patterns */
+export declare class ErrorFormatDetector extends RegexDetector {
+    readonly id = "api/error-format";
+    readonly name = "Error Format Detector";
+    readonly description = "Detects error response format patterns and consistency";
+    readonly category = "api";
+    readonly subcategory = "errors";
+    readonly supportedLanguages: Language[];
+    detect(context: DetectionContext): Promise<DetectionResult>;
+    generateQuickFix(): null;
+}
+/** Create a new ErrorFormatDetector instance */
+export declare function createErrorFormatDetector(): ErrorFormatDetector;
+//# sourceMappingURL=error-format.d.ts.map

package/dist/api/error-format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-format.d.ts","sourceRoot":"","sources":["../../src/api/error-format.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAM9F,sCAAsC;AACtC,MAAM,MAAM,WAAW,GACnB,UAAU,GACV,iBAAiB,GACjB,UAAU,GACV,SAAS,GACT,QAAQ,GACR,QAAQ,CAAC;AAEb,8CAA8C;AAC9C,MAAM,MAAM,sBAAsB,GAC9B,cAAc,GACd,aAAa,GACb,aAAa,GACb,aAAa,GACb,gBAAgB,GAChB,aAAa,CAAC;AAElB,gDAAgD;AAChD,MAAM,MAAM,wBAAwB,GAChC,qBAAqB,GACrB,iBAAiB,GACjB,cAAc,GACd,kBAAkB,GAClB,eAAe,GACf,oBAAoB,GACpB,gBAAgB,GAChB,eAAe,CAAC;AAGpB,wDAAwD;AACxD,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,MAAM,EAAE,WAAW,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B;AAED,0DAA0D;AAC1D,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,kDAAkD;AAClD,MAAM,WAAW,mBAAmB;IAClC,aAAa,EAAE,sBAAsB,EAAE,CAAC;IACxC,UAAU,EAAE,wBAAwB,EAAE,CAAC;IACvC,cAAc,EAAE,WAAW,GAAG,IAAI,CAAC;IACnC,oBAAoB,EAAE,OAAO,CAAC;IAC9B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,0BAA0B,EAAE,MAAM,CAAC;CACpC;AAMD,4BAA4B;AAC5B,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAC;AAEX,sCAAsC;AACtC,eAAO,MAAM,sBAAsB,4DAA6D,CAAC;AAEjG,4BAA4B;AAC5B,eAAO,MAAM,qBAAqB,2EAA4E,CAAC;AAE/G,2BAA2B;AAC3B,eAAO,MAAM,oBAAoB,yDAA0D,CAAC;AAE5F,iCAAiC;AACjC,eAAO,MAAM,mBAAmB;;;;;;CAMtB,CAAC;AAEX,+BAA+B;AAC/B,eAAO,MAAM,oBAAoB,2BAGvB,CAAC;AAEX,8BAA8B;AAC9B,eAAO,MAAM,uBAAuB,2CAK1B,CAAC;AAEX,2BAA2B;AAC3B,eAAO,MAAM,oBAAoB,2CAKvB,CAAC;AAEX,2BAA2B;AAC3B,eAAO,MAAM,oBAAoB,2BAGvB,CAAC;AAEX,+BAA+B;AAC/B,eAAO,MAAM,sBAAsB,UAOlC,CAAC;AAOF,wDAAwD;AACxD,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAE3D;AA2BD,wDAAwD;AACxD,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE,CAQjE;AAED,0CAA0C;AAC1C,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAmC/D;AAED,0CAA0C;AAC1C,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAKrE;AAED,iDAAiD;AACjD,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAGlD;AAOD,mCAAmC;AACnC,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,sBAAsB,EAAE,CAgC1F;AAED,qCAAqC;AACrC,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,sBAAsB,EAAE,CA2C1F;AAED,kCAAkC;AAClC,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,sBAAsB,EAAE,CA0BzF;AAED,qDAAqD;AACrD,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,sBAAsB,EAAE,CAqC5F;AAOD,kDAAkD;AAClD,wBAAgB,kCAAkC,CAChD,QAAQ,EAAE,sBAAsB,EAAE,EAClC,IAAI,EAAE,MAAM,GACX,wBAAwB,EAAE,CAyC5B;AAED,+CAA+C;AAC/C,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,sBAAsB,EAAE,EAClC,IAAI,EAAE,MAAM,GACX,wBAAwB,EAAE,CA6C5B;AAED,yCAAyC;AACzC,wBAAgB,8BAA8B,CAC5C,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GACX,wBAAwB,EAAE,CAiC5B;AAED,4CAA4C;AAC5C,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,sBAAsB,EAAE,EAClC,IAAI,EAAE,MAAM,GACX,wBAAwB,EAAE,CA4B5B;AAED,uDAAuD;AACvD,wBAAgB,gCAAgC,CAC9C,QAAQ,EAAE,sBAAsB,EAAE,EAClC,IAAI,EAAE,MAAM,GACX,wBAAwB,EAAE,CA8C5B;AAOD,oDAAoD;AACpD,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,mBAAmB,CAmFrF;AAMD,qEAAqE;AACrE,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,QAAQ,CAAC,EAAE,sBAAsB;IACjC,QAAQ,CAAC,IAAI,2BAA2B;IACxC,QAAQ,CAAC,WAAW,4DAA4D;IAChF,QAAQ,CAAC,QAAQ,SAAS;IAC1B,QAAQ,CAAC,WAAW,YAAY;IAChC,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,EAAE,CAA0C;IAE3E,MAAM,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IAWjE,gBAAgB,IAAI,IAAI;CAGzB;AAED,gDAAgD;AAChD,wBAAgB,yBAAyB,IAAI,mBAAmB,CAE/D"}