driftdetect-detectors 0.1.0

package/dist/api/http-methods.d.ts

@@ -0,0 +1,255 @@
+/**
+ * HTTP Methods Detector - HTTP method usage pattern detection
+ *
+ * Detects HTTP method usage patterns including:
+ * - HTTP method usage (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS)
+ * - RESTful method conventions (GET for read, POST for create, PUT/PATCH for update, DELETE for remove)
+ * - Express/Fastify method handlers (router.get, router.post, etc.)
+ * - Next.js App Router method exports (export function GET, POST, etc.)
+ * - Fetch API method usage (fetch with method option)
+ * - Axios method usage (axios.get, axios.post, etc.)
+ *
+ * Flags violations:
+ * - Using POST for read operations (should be GET)
+ * - Using GET for mutations (should be POST/PUT/PATCH/DELETE)
+ * - Missing method handlers for common operations
+ * - Inconsistent method usage across similar endpoints
+ * - Using PUT when PATCH is more appropriate (partial updates)
+ *
+ * @requirements 10.2 - THE API_Detector SHALL detect HTTP method usage patterns (POST vs PUT vs PATCH)
+ */
+import type { Violation, QuickFix, Language } from 'driftdetect-core';
+import { RegexDetector, type DetectionContext, type DetectionResult } from '../base/index.js';
+/**
+ * HTTP methods supported
+ */
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+/**
+ * Types of HTTP method patterns detected
+ */
+export type HttpMethodPatternType = 'express-handler' | 'nextjs-app-router' | 'fetch-api' | 'axios-method' | 'http-client' | 'method-constant';
+/**
+ * Types of HTTP method violations detected
+ */
+export type HttpMethodViolationType = 'post-for-read' | 'get-for-mutation' | 'put-for-partial' | 'inconsistent-method' | 'missing-method-handler' | 'non-restful-method';
+/**
+ * Information about a detected HTTP method usage
+ */
+export interface HttpMethodUsageInfo {
+    /** Type of HTTP method pattern */
+    type: HttpMethodPatternType;
+    /** HTTP method used */
+    method: HttpMethod;
+    /** File path */
+    file: string;
+    /** Line number (1-indexed) */
+    line: number;
+    /** Column number (1-indexed) */
+    column: number;
+    /** The matched text */
+    matchedText: string;
+    /** Route path (if available) */
+    routePath?: string | undefined;
+    /** Operation type inferred from context */
+    operationType?: 'read' | 'create' | 'update' | 'delete' | 'unknown' | undefined;
+    /** Additional context */
+    context?: string | undefined;
+}
+/**
+ * Information about a detected HTTP method violation
+ */
+export interface HttpMethodViolationInfo {
+    /** Type of violation */
+    type: HttpMethodViolationType;
+    /** File path */
+    file: string;
+    /** Line number (1-indexed) */
+    line: number;
+    /** Column number (1-indexed) */
+    column: number;
+    /** End line number (1-indexed) */
+    endLine: number;
+    /** End column number (1-indexed) */
+    endColumn: number;
+    /** The problematic method */
+    method: HttpMethod;
+    /** Issue description */
+    issue: string;
+    /** Suggested fix */
+    suggestedFix?: string | undefined;
+    /** Suggested method to use instead */
+    suggestedMethod?: HttpMethod | undefined;
+    /** The full line content */
+    lineContent: string;
+}
+/**
+ * Analysis of HTTP method patterns in a file
+ */
+export interface HttpMethodAnalysis {
+    /** HTTP method usages found */
+    methodUsages: HttpMethodUsageInfo[];
+    /** Violations detected */
+    violations: HttpMethodViolationInfo[];
+    /** Methods used in the file */
+    methodsUsed: Set<HttpMethod>;
+    /** Whether file uses RESTful conventions */
+    usesRestfulConventions: boolean;
+    /** Pattern adherence confidence */
+    patternAdherenceConfidence: number;
+}
+/**
+ * All supported HTTP methods
+ */
+export declare const HTTP_METHODS: readonly HttpMethod[];
+/**
+ * HTTP methods for read operations
+ */
+export declare const READ_METHODS: readonly HttpMethod[];
+/**
+ * HTTP methods for mutation operations
+ */
+export declare const MUTATION_METHODS: readonly HttpMethod[];
+/**
+ * RESTful method conventions mapping
+ */
+export declare const RESTFUL_METHOD_CONVENTIONS: Record<string, HttpMethod[]>;
+/**
+ * Keywords indicating read operations
+ */
+export declare const READ_OPERATION_KEYWORDS: Set<string>;
+/**
+ * Keywords indicating mutation operations
+ */
+export declare const MUTATION_OPERATION_KEYWORDS: Set<string>;
+/**
+ * Keywords indicating partial update operations
+ */
+export declare const PARTIAL_UPDATE_KEYWORDS: Set<string>;
+/**
+ * Keywords indicating full replacement operations
+ */
+export declare const FULL_REPLACEMENT_KEYWORDS: Set<string>;
+/**
+ * Express/Fastify route handler patterns
+ */
+export declare const EXPRESS_METHOD_PATTERNS: readonly [RegExp, RegExp, RegExp, RegExp];
+/**
+ * Next.js App Router method export patterns
+ */
+export declare const NEXTJS_METHOD_EXPORT_PATTERN: RegExp;
+/**
+ * Fetch API method patterns
+ */
+export declare const FETCH_METHOD_PATTERNS: readonly [RegExp];
+/**
+ * Axios method patterns
+ */
+export declare const AXIOS_METHOD_PATTERNS: readonly [RegExp, RegExp, RegExp];
+/**
+ * Generic HTTP client patterns
+ */
+export declare const HTTP_CLIENT_PATTERNS: readonly [RegExp, RegExp, RegExp, RegExp, RegExp];
+/**
+ * File patterns to exclude from detection
+ */
+export declare const EXCLUDED_FILE_PATTERNS: RegExp[];
+/**
+ * Check if a file should be excluded from detection
+ */
+export declare function shouldExcludeFile(filePath: string): boolean;
+/**
+ * Normalize HTTP method to uppercase
+ */
+export declare function normalizeMethod(method: string): HttpMethod;
+/**
+ * Check if a method is a read method
+ */
+export declare function isReadMethod(method: HttpMethod): boolean;
+/**
+ * Check if a method is a mutation method
+ */
+export declare function isMutationMethod(method: HttpMethod): boolean;
+/**
+ * Infer operation type from context (route path, function name, etc.)
+ */
+export declare function inferOperationType(context: string, routePath?: string): 'read' | 'create' | 'update' | 'delete' | 'unknown';
+/**
+ * Detect Express/Fastify route handlers
+ */
+export declare function detectExpressHandlers(content: string, file: string): HttpMethodUsageInfo[];
+/**
+ * Detect Next.js App Router method exports
+ */
+export declare function detectNextjsMethodExports(content: string, file: string): HttpMethodUsageInfo[];
+/**
+ * Detect Fetch API method usage
+ */
+export declare function detectFetchApiUsage(content: string, file: string): HttpMethodUsageInfo[];
+/**
+ * Detect Axios method usage
+ */
+export declare function detectAxiosUsage(content: string, file: string): HttpMethodUsageInfo[];
+/**
+ * Detect generic HTTP client usage
+ */
+export declare function detectHttpClientUsage(content: string, file: string): HttpMethodUsageInfo[];
+/**
+ * Detect POST used for read operations
+ */
+export declare function detectPostForReadViolations(methodUsages: HttpMethodUsageInfo[], file: string): HttpMethodViolationInfo[];
+/**
+ * Detect GET used for mutation operations
+ */
+export declare function detectGetForMutationViolations(methodUsages: HttpMethodUsageInfo[], file: string): HttpMethodViolationInfo[];
+/**
+ * Detect PUT used when PATCH is more appropriate
+ */
+export declare function detectPutForPartialUpdateViolations(methodUsages: HttpMethodUsageInfo[], file: string): HttpMethodViolationInfo[];
+/**
+ * Detect inconsistent method usage across similar endpoints
+ */
+export declare function detectInconsistentMethodUsage(methodUsages: HttpMethodUsageInfo[], file: string): HttpMethodViolationInfo[];
+/**
+ * Analyze HTTP method patterns in a file
+ */
+export declare function analyzeHttpMethods(content: string, file: string): HttpMethodAnalysis;
+/**
+ * Detector for HTTP method usage patterns
+ *
+ * Identifies HTTP method usage patterns and flags violations of RESTful conventions.
+ *
+ * @requirements 10.2 - THE API_Detector SHALL detect HTTP method usage patterns (POST vs PUT vs PATCH)
+ */
+export declare class HttpMethodsDetector extends RegexDetector {
+    readonly id = "api/http-methods";
+    readonly category: "api";
+    readonly subcategory = "http-methods";
+    readonly name = "HTTP Methods Detector";
+    readonly description = "Detects HTTP method usage patterns and flags RESTful convention violations";
+    readonly supportedLanguages: Language[];
+    /**
+     * Detect HTTP method patterns and violations
+     */
+    detect(context: DetectionContext): Promise<DetectionResult>;
+    /**
+     * Create a Violation from HttpMethodViolationInfo
+     */
+    private createViolation;
+    /**
+     * Get explanation for a violation type
+     */
+    private getExplanation;
+    /**
+     * Create a quick fix for a violation
+     */
+    private createQuickFixForViolation;
+    /**
+     * Generate a quick fix for a violation
+     */
+    generateQuickFix(violation: Violation): QuickFix | null;
+}
+/**
+ * Create a new HttpMethodsDetector instance
+ */
+export declare function createHttpMethodsDetector(): HttpMethodsDetector;
+//# sourceMappingURL=http-methods.d.ts.map

package/dist/api/http-methods.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-methods.d.ts","sourceRoot":"","sources":["../../src/api/http-methods.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,KAAK,EAAgB,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAM9F;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;AAE1F;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,iBAAiB,GACjB,mBAAmB,GACnB,WAAW,GACX,cAAc,GACd,aAAa,GACb,iBAAiB,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC/B,eAAe,GACf,kBAAkB,GAClB,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,oBAAoB,CAAC;AAEzB;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,kCAAkC;IAClC,IAAI,EAAE,qBAAqB,CAAC;IAC5B,uBAAuB;IACvB,MAAM,EAAE,UAAU,CAAC;IACnB,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,2CAA2C;IAC3C,aAAa,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;IAChF,yBAAyB;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,wBAAwB;IACxB,IAAI,EAAE,uBAAuB,CAAC;IAC9B,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,MAAM,EAAE,UAAU,CAAC;IACnB,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,sCAAsC;IACtC,eAAe,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IACzC,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,+BAA+B;IAC/B,YAAY,EAAE,mBAAmB,EAAE,CAAC;IACpC,0BAA0B;IAC1B,UAAU,EAAE,uBAAuB,EAAE,CAAC;IACtC,+BAA+B;IAC/B,WAAW,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7B,4CAA4C;IAC5C,sBAAsB,EAAE,OAAO,CAAC;IAChC,mCAAmC;IACnC,0BAA0B,EAAE,MAAM,CAAC;CACpC;AAMD;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,SAAS,UAAU,EAEpC,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,SAAS,UAAU,EAAwC,CAAC;AAEvF;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAAS,UAAU,EAAgD,CAAC;AAEnG;;GAEG;AACH,eAAO,MAAM,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CA+B1D,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,uBAAuB,aAGlC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,2BAA2B,aAItC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,uBAAuB,aAElC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,yBAAyB,aAEpC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,uBAAuB,2CAQ1B,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,4BAA4B,QAC2C,CAAC;AAErF;;GAEG;AACH,eAAO,MAAM,qBAAqB,mBAGxB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,qBAAqB,mCAOxB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,oBAAoB,mDAWvB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,sBAAsB,UAOlC,CAAC;AAMF;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAE3D;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAE1D;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAExD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAE5D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CA0CrD;AA2CD;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GACX,mBAAmB,EAAE,CA+CvB;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GACX,mBAAmB,EAAE,CAuCvB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GACX,mBAAmB,EAAE,CA+BvB;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GACX,mBAAmB,EAAE,CA+BvB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GACX,mBAAmB,EAAE,CA+BvB;AAMD;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,YAAY,EAAE,mBAAmB,EAAE,EACnC,IAAI,EAAE,MAAM,GACX,uBAAuB,EAAE,CA8C3B;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC5C,YAAY,EAAE,mBAAmB,EAAE,EACnC,IAAI,EAAE,MAAM,GACX,uBAAuB,EAAE,CAgE3B;AAED;;GAEG;AACH,wBAAgB,mCAAmC,CACjD,YAAY,EAAE,mBAAmB,EAAE,EACnC,IAAI,EAAE,MAAM,GACX,uBAAuB,EAAE,CAsD3B;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,mBAAmB,EAAE,EACnC,IAAI,EAAE,MAAM,GACX,uBAAuB,EAAE,CAwD3B;AAMD;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GACX,kBAAkB,CAgEpB;AAMD;;;;;;GAMG;AACH,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,QAAQ,CAAC,EAAE,sBAAsB;IACjC,QAAQ,CAAC,QAAQ,EAAG,KAAK,CAAU;IACnC,QAAQ,CAAC,WAAW,kBAAkB;IACtC,QAAQ,CAAC,IAAI,2BAA2B;IACxC,QAAQ,CAAC,WAAW,gFAAgF;IACpG,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,EAAE,CAA0C;IAEjF;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IAkDjE;;OAEG;IACH,OAAO,CAAC,eAAe;IAuCvB;;OAEG;IACH,OAAO,CAAC,cAAc;IA2BtB;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAqClC;;OAEG;IACH,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,QAAQ,GAAG,IAAI;CA8BxD;AAMD;;GAEG;AACH,wBAAgB,yBAAyB,IAAI,mBAAmB,CAE/D"}