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 | 1x 1x 7x 7x 7x 1x 7x 7x 7x 7x 7x 7x 7x 7x 7x 5x 5x 3x 3x 5x 2x 7x 7x 7x 7x 7x 7x 7x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 10x 10x 10x 70x 9x 9x 10x 10x 10x 1x 5x 4x 4x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 1x 10x 10x 2x 2x 10x 2x 2x 10x 2x 2x 4x 4x 1x 9x 3x 9x 3x 3x 3x 1x 2x 3x 3x 3x 3x 1x 2x 3x 9x | import { SecurityLevel } from "../types/cia"; /** * Utility functions for formatting values consistently across the application * * ## Business Perspective * * Consistent formatting ensures that business metrics, costs, and security levels * are displayed uniformly across the application, improving comprehension and * professionalism in security reports and dashboards. 📊 * * These utilities support clear communication of risk and investment data to * both technical and business stakeholders. */ /** * Converts a string to title case * * @param str - The string to convert to title case * @returns The title-cased string */ export function toTitleCase(str: string): string { return str.replace( /\w\S*/g, (txt) => txt.charAt(0).toUpperCase() + txt.substring(1).toLowerCase() ); } /** * Formats a decimal as a percentage * * @param value - Decimal value (0.75 = 75%) * @param decimalPlaces - Number of decimal places to show * @returns Formatted percentage string */ export function formatPercentage(value: number, decimalPlaces: number = 0): string { // Multiply by 100 to convert decimal to percentage const percentage = value * 100; // Format with specified decimal places return `${percentage.toFixed(decimalPlaces)}%`; } /** * Formats a number as currency with proper thousands separators * * @param value - The number to format as currency * @param options - Formatting options or currency code string for backward compatibility * @param locale - Optional locale for backward compatibility * @returns Formatted currency string */ export function formatCurrency( value: number, options?: { locale?: string; currency?: string; minimumFractionDigits?: number; maximumFractionDigits?: number; } | string, locale?: string ): string { // Default values let currencyCode = 'USD'; let localeValue = 'en-US'; let minFractionDigits = 0; let maxFractionDigits = 0; // Handle backward compatibility with string options if (typeof options === 'string') { currencyCode = options; if (locale) { localeValue = locale; } } // Handle object options else if (options && typeof options === 'object') { if (options.currency) currencyCode = options.currency; if (options.locale) localeValue = options.locale; if (options.minimumFractionDigits !== undefined) minFractionDigits = options.minimumFractionDigits; if (options.maximumFractionDigits !== undefined) maxFractionDigits = options.maximumFractionDigits; } // Use Intl.NumberFormat for consistent currency formatting return new Intl.NumberFormat(localeValue, { style: 'currency', currency: currencyCode, minimumFractionDigits: minFractionDigits, maximumFractionDigits: maxFractionDigits }).format(value); } // For backward compatibility, re-export this function export const formatCurrencyWithOptions = formatCurrency; /** * Format security level for display (capitalize first letter) * * @param level - Security level * @returns Formatted security level string */ export function formatSecurityLevel(level: SecurityLevel): string { return level; } /** * Risk level icons for different risk levels */ const RISK_LEVEL_ICONS: Record<string, string> = { "Critical Risk": "⚠️", "High Risk": "🔴", "Medium Risk": "🟠", "Low Risk": "🟡", "Minimal Risk": "🟢", "No Risk": "✅", "Unknown Risk": "❓" }; /** * Formats a risk level by adding an appropriate icon * * @param riskLevel - The risk level text to format * @returns Risk level with icon prefix */ export function formatRiskLevel(riskLevel: string): string { // Handle case insensitivity by checking against lowercase values let icon = "❓"; // Default icon for unknown risk levels // Look up the icon based on the risk level const riskLowerCase = riskLevel.toLowerCase(); Object.entries(RISK_LEVEL_ICONS).forEach(([level, levelIcon]) => { if (level.toLowerCase() === riskLowerCase) { icon = levelIcon; } }); // Return risk level with the icon return `${icon} ${riskLevel}`; } /** * Format a number with thousands separators and optional decimal places * * @param value - Number to format * @param decimalPlaces - Optional decimal places * @returns Formatted number with thousand separators */ export function formatNumber(value: number, decimalPlaces?: number): string { if (decimalPlaces !== undefined) { return value.toFixed(decimalPlaces); } return value.toLocaleString(); } /** * Format a number with specified decimal places * * @param value - Number to format * @param decimalPlaces - Number of decimal places * @returns Formatted number string */ export function formatNumberWithDecimals(value: number, decimalPlaces: number): string { return value.toFixed(decimalPlaces); } /** * Format a cost value for budget display (adds "% of IT budget" text) * * @param value - Cost percentage value * @param isCapex - Whether this is capital expenditure (vs operational) * @returns Formatted budget string */ export function formatBudgetPercentage(value: number, isCapex: boolean): string { const percentValue = formatPercentage(value); const budgetType = isCapex ? "of IT budget as one-time capital expenditure" : "of IT budget as annual operational expenses"; return `${percentValue} ${budgetType}`; } /** * Format uptime percentage for availability display * * @param uptime - Uptime value (e.g., "99.9%") * @returns Formatted uptime string */ export function formatUptime(uptime: string): string { // If uptime is already formatted, return as is if (uptime.includes('%')) { return uptime; } // Try to convert to a percentage if it's a number const uptimeValue = parseFloat(uptime); if (!isNaN(uptimeValue)) { return formatPercentage(uptimeValue); } // If not a percentage, return as is return uptime; } /** * Formats a date using the browser's local formatting * * ## Business Perspective * * Consistent date formatting improves the readability of audit records, * compliance documentation, and implementation timelines. 📅 * * @param date - Date object or string to format * @param options - Date formatting options * @returns Formatted date string */ export function formatDate( date: Date | string, options: Intl.DateTimeFormatOptions = { year: "numeric", month: "short", day: "numeric", } ): string { const dateObj = typeof date === "string" ? new Date(date) : date; return new Intl.DateTimeFormat(undefined, options).format(dateObj); } /** * Formats a large number with abbreviated suffixes (K, M, B) * * ## Business Perspective * * Large financial figures become more readable with appropriate * abbreviations, making high-level financial impact assessments * more accessible to executives and stakeholders. 💼 * * @param value - The number to format * @returns Abbreviated number string */ export function formatLargeNumber(value: number): string { const absValue = Math.abs(value); if (absValue >= 1_000_000_000) { return `${(value / 1_000_000_000).toFixed(1)}B`; } if (absValue >= 1_000_000) { return `${(value / 1_000_000).toFixed(1)}M`; } if (absValue >= 1_000) { return `${(value / 1_000).toFixed(1)}K`; } return value.toString(); } /** * Formats a timeframe in a human-readable format * * ## Business Perspective * * Recovery time objectives and implementation timeframes are critical * in security planning and need to be presented consistently for * accurate business impact assessment. ⏱️ * * @param minutes - Time in minutes * @returns Formatted time string */ export function formatTimeframe(minutes: number): string { if (minutes < 60) { return `${minutes} minutes`; } else if (minutes < 1440) { const hours = Math.floor(minutes / 60); const remainingMinutes = minutes % 60; return remainingMinutes > 0 ? `${hours} hours, ${remainingMinutes} minutes` : `${hours} hours`; } else { const days = Math.floor(minutes / 1440); const remainingHours = Math.floor((minutes % 1440) / 60); return remainingHours > 0 ? `${days} days, ${remainingHours} hours` : `${days} days`; } } |