All files / src/types cia-services.ts

100% Statements 5/5
100% Branches 2/2
100% Functions 1/1
100% Lines 5/5

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379                                                      1x 14x 14x 11x   14x                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
/**
 * CIA security service types and interfaces
 *
 * ## Business Perspective
 *
 * These types define the core data structures for representing CIA security
 * information across the application. They enable consistent data handling
 * and provide a common language for discussing security controls between
 * technical and business stakeholders. 🔒
 */
 
import { SecurityLevel } from "./cia";
 
// Re-export SecurityLevel for backward compatibility
export type { SecurityLevel };
 
/**
 * Type representing CIA component types
 */
export type CIAComponentType = "confidentiality" | "integrity" | "availability";
 
/**
 * Type guard to check if a value is a valid CIA component type
 *
 * @param value - Value to check
 * @returns True if value is a valid CIA component type
 */
export function isCIAComponentType(value: unknown): value is CIAComponentType {
  return (
    typeof value === "string" &&
    ["confidentiality", "integrity", "availability"].includes(value)
  );
}
 
/**
 * Business impact category details
 */
export interface ImpactCategoryDetails {
  description: string;
  riskLevel: string;
  complianceViolations?: string[];
  complianceImpact?: string;
  competitiveAdvantage?: string;
  annualRevenueLoss?: string;
  meanTimeToRecover?: string;
}
 
/**
 * Business impact detail for specific impact categories
 */
export interface BusinessImpactDetail {
  /**
   * Description of the impact
   */
  description: string;
 
  /**
   * Risk level associated with this impact
   */
  riskLevel: string;
 
  /**
   * Annual revenue loss estimate
   */
  annualRevenueLoss?: string;
 
  /**
   * Mean time to recover from incidents
   */
  meanTimeToRecover?: string;
 
  /**
   * List of potential compliance violations
   */
  complianceViolations?: string[];
 
  /**
   * Competitive advantage implications
   */
  competitiveAdvantage?: string;
 
  /**
   * Compliance impact description
   */
  complianceImpact?: string;
 
  /**
   * Reputational impact description
   */
  reputationalImpact?: string;
}
 
/**
 * Business impact details
 */
export interface BusinessImpactDetails {
  summary: string; // Required summary property
 
  // Either use the new names or the legacy names
  financial?: BusinessImpactDetail;
  operational?: BusinessImpactDetail;
 
  // Legacy property names kept for backward compatibility
  financialImpact?: BusinessImpactDetail;
  operationalImpact?: BusinessImpactDetail;
 
  // Optional detail types
  reputational?: BusinessImpactDetail;
  reputationalImpact?: BusinessImpactDetail;
  strategic?: BusinessImpactDetail;
  regulatory?: BusinessImpactDetail;
}
 
/**
 * Technical implementation effort details
 */
export interface ImplementationEffort {
  development: string;
  maintenance: string;
  expertise: string;
}
 
/**
 * Technical implementation details
 */
export interface TechnicalImplementationDetails {
  description: string;
  implementationSteps: string[];
  effort: {
    development: string;
    maintenance: string;
    expertise: string;
  };
  // Add the component-specific properties
  validationMethod?: string; // For integrity
  protectionMethod?: string; // For confidentiality
  recoveryMethod?: string; // For availability
  [key: string]: any; // Allow additional properties
}
 
/**
 * Code example for technical implementation
 */
export interface CodeExample {
  language: string;
  title: string;
  code: string;
}
 
/**
 * Compliance impact details
 */
export interface ComplianceImpact {
  frameworks?: {
    compliant: string[];
    partiallyCompliant: string[];
    nonCompliant: string[];
  };
  requirements: string[];
  remediationSteps: string[];
}
 
/**
 * Return on investment estimate
 */
export interface ROIEstimate {
  returnRate: string; // Required property
  description: string;
  value?: string; // For backward compatibility
  potentialSavings?: string;
  breakEvenPeriod?: string;
}
 
/**
 * Return on investment metrics
 */
export interface ROIMetrics {
  value: string;
  percentage: string;
  description: string;
}
 
/**
 * ROI estimates map by security level
 */
export interface ROIEstimatesMap {
  NONE: ROIEstimate;
  LOW: ROIEstimate;
  MODERATE: ROIEstimate;
  HIGH: ROIEstimate;
  VERY_HIGH: ROIEstimate;
  // Remove duplicate index signature, keep only one
  [key: string]: ROIEstimate; // Add string index signature for easier access
}
 
/**
 * Core CIA security details interface
 *
 * This comprehensive interface represents all security details for a specific
 * security level across availability, integrity, or confidentiality.
 */
export interface CIADetails {
  // Core descriptive fields
  description: string;
  technical: string;
  businessImpact: string;
  impact?: string; // Legacy field - use businessImpact instead
 
  // Financial metrics
  capex: number;
  opex: number;
 
  // Styling properties
  bg: string;
  text: string;
 
  // Security guidance
  recommendations: string[];
 
  // Business impact analysis
  businessImpactDetails?: BusinessImpactDetails;
 
  // Availability-specific metrics
  uptime?: string;
  rto?: string;
  rpo?: string;
  mttr?: string;
 
  // Integrity-specific metrics
  validationMethod?: string;
 
  // Confidentiality-specific metrics
  protectionMethod?: string;
 
  // Implementation details
  implementationComplexity?: string;
  maintenanceRequirements?: string;
  requiredExpertise?: string;
  controlFamily?: string[];
  applicableFrameworks?: string[];
 
  // Business perspective and value creation
  businessPerspective?: string;
  implementationSteps?: string[];
  effort?: ImplementationEffort;
  keyImpact?: string;
  metric?: string;
  valuePoints?: string[];
  roiEstimate?: ROIEstimate;
  implementationConsiderations?: string;
 
  // Visual and compliance indicators
  securityIcon?: string;
  complianceImpact?: ComplianceImpact;
 
  // Implementation guidance
  codeExamples?: CodeExample[];
  technicalImplementation?: TechnicalImplementationDetails;
 
  // Add missing properties
  expertise?: string;
  timeframe?: string;
}
 
/**
 * @deprecated Use CIADetails instead - kept for backward compatibility
 */
export type EnhancedCIADetails = CIADetails;
 
/**
 * Data provider for CIA security information
 */
export interface CIADataProvider {
  /**
   * Initialize the data provider
   */
  initialize?: () => Promise<boolean>;
 
  availabilityOptions: Record<SecurityLevel, CIADetails>;
  integrityOptions: Record<SecurityLevel, CIADetails>;
  confidentialityOptions: Record<SecurityLevel, CIADetails>;
  roiEstimates: ROIEstimatesMap;
 
  /**
   * Get default security icon for a security level
   */
  getDefaultSecurityIcon?: (level: SecurityLevel) => string;
 
  /**
   * Get default expertise level for a security level
   */
  getDefaultExpertiseLevel?: (level: SecurityLevel) => string;
 
  /**
   * Get protection level for a security level
   */
  getProtectionLevel?: (level: SecurityLevel) => string;
 
  /**
   * Get default value points for a security level
   */
  getDefaultValuePoints?: (level: SecurityLevel) => string[];
 
  /**
   * Get value points for a security level
   * @deprecated Use getDefaultValuePoints instead
   */
  getValuePoints?: (level: SecurityLevel) => string[];
 
  /**
   * Get security level recommendations
   */
  getSecurityLevelRecommendations?: (level: SecurityLevel) => Promise<string[]>;
 
  /**
   * Get compliance frameworks
   */
  getComplianceFrameworks?: () => Promise<any[]>;
 
  /**
   * Get compliance requirements
   */
  getComplianceRequirements?: () => Promise<any>;
 
  /**
   * Get business impact
   */
  getBusinessImpact?: () => Promise<any>;
 
  /**
   * Get security metrics
   */
  getSecurityMetrics?: () => Promise<any>;
 
  /**
   * Get security resources
   */
  getSecurityResources?: () => Promise<any[]>;
 
  /**
   * Get SLA metrics
   */
  getSLAMetrics?: () => Promise<any>;
 
  /**
   * Get cost estimates
   */
  getCostEstimates?: () => Promise<any>;
 
  /**
   * Get value creation metrics
   */
  getValueCreationMetrics?: () => Promise<any>;
 
  /**
   * Get implementation details
   */
  getImplementationDetails?: () => Promise<any>;
 
  /**
   * Get remediation steps
   */
  getRemediationSteps?: () => Promise<any[]>;
}
 
// Types used by CIA service modules
 
export interface ComplianceStatus {
  status: string;
  compliantFrameworks: string[];
  partiallyCompliantFrameworks: string[];
  nonCompliantFrameworks: string[];
  remediationSteps?: string[];
  complianceScore: number;
  // ...other properties...
}
 
// ...existing types if any...