ctrlshiftleft/src/types/checklistTypes.ts

AI-powered toolkit for embedding QA and security testing into development workflows

/**
 * Risk impact levels for security issues
 */
export type ImpactLevel = 'critical' | 'high' | 'medium' | 'low' | 'info';

/**
 * Likelihood levels for security issues
 */
export type LikelihoodLevel = 'very-high' | 'high' | 'medium' | 'low' | 'very-low';

/**
 * Security vulnerability classification using Common Weakness Enumeration
 */
export interface SecurityReference {
  cwe?: string;        // Common Weakness Enumeration ID (e.g., 'CWE-79')
  owasp?: string;      // OWASP category (e.g., 'A1:2021-Broken Access Control')
  description?: string; // Description of the standard
  url?: string;        // Link to more information
}

/**
 * Detailed remediation guidance for security issues
 */
export interface RemediationInfo {
  description: string;  // Human-readable remediation guidance
  codeExample?: string; // Code example showing fixed implementation
  effort?: 'high' | 'medium' | 'low'; // Estimated remediation effort
  priority?: 'immediate' | 'high' | 'medium' | 'low'; // Suggested fix priority
}

/**
 * Risk score calculation using CVSS or similar methodology
 */
export interface RiskScoreInfo {
  score: number;        // Numeric score (e.g., 0-10 for CVSS)
  vector?: string;      // Vector string (e.g., CVSS vector)
  impact: ImpactLevel;  // Impact if exploited
  likelihood: LikelihoodLevel; // Likelihood of exploitation
  calculator?: string;  // Method used (e.g., 'CVSS-3.1', 'OWASP Risk')
}

/**
 * Checklist item representing a QA or security check
 */
export interface ChecklistItem {
  id: string;
  title: string;
  description: string;
  category: string;
  severity: 'critical' | 'high' | 'medium' | 'low' | 'info';
  verification?: string;
  status?: 'pending' | 'passed' | 'failed' | 'na';
  comments?: string;
  file?: string;        // Source file containing the issue
  lineNumber?: number;  // Approximate line number of the issue
  codeSnippet?: string; // Relevant code snippet
  
  // Enhanced security information (only for security items)
  references?: SecurityReference[];
  remediation?: RemediationInfo;
  riskScore?: RiskScoreInfo;
  
  // Additional metadata
  createdAt?: string;   // ISO date string when the item was created
  updatedAt?: string;   // ISO date string when the item was last updated
}

/**
 * Complete checklist with metadata and items
 */
export interface Checklist {
  title: string;
  description: string;
  categories: string[];
  items: ChecklistItem[];
  markdown?: string; // Optional markdown representation
}