@nahisaho/musubix-security 1.8.0 → 1.8.5

package/dist/remediation/remediation-planner.d.ts

@@ -0,0 +1,262 @@
+/**
+ * @fileoverview Remediation Planner for Security Vulnerabilities
+ * @module @nahisaho/musubix-security/remediation/remediation-planner
+ *
+ * Plans and prioritizes remediation of security vulnerabilities
+ * considering dependencies, risk, and effort.
+ */
+import type { Vulnerability, Fix, ScanResult } from '../types/index.js';
+/**
+ * Remediation plan
+ */
+export interface RemediationPlan {
+    /** Plan ID */
+    id: string;
+    /** Plan name */
+    name: string;
+    /** Created timestamp */
+    createdAt: Date;
+    /** Plan status */
+    status: PlanStatus;
+    /** Total vulnerabilities */
+    totalVulnerabilities: number;
+    /** Planned phases */
+    phases: RemediationPhase[];
+    /** Estimated effort */
+    estimatedEffort: EffortEstimate;
+    /** Risk reduction */
+    riskReduction: RiskReduction;
+    /** Dependencies between fixes */
+    dependencies: FixDependency[];
+    /** Metadata */
+    metadata: PlanMetadata;
+}
+/**
+ * Plan status
+ */
+export type PlanStatus = 'draft' | 'approved' | 'in-progress' | 'completed' | 'cancelled';
+/**
+ * Remediation phase
+ */
+export interface RemediationPhase {
+    /** Phase number */
+    phase: number;
+    /** Phase name */
+    name: string;
+    /** Description */
+    description: string;
+    /** Fixes in this phase */
+    fixes: PlannedFix[];
+    /** Estimated duration */
+    estimatedDuration: Duration;
+    /** Prerequisites */
+    prerequisites: string[];
+    /** Risk level after phase */
+    residualRisk: RiskLevel;
+}
+/**
+ * Planned fix
+ */
+export interface PlannedFix {
+    /** Fix reference */
+    fix: Fix;
+    /** Vulnerability reference */
+    vulnerability: Vulnerability;
+    /** Priority score */
+    priorityScore: number;
+    /** Effort estimate */
+    effort: EffortEstimate;
+    /** Blocked by (fix IDs) */
+    blockedBy: string[];
+    /** Blocks (fix IDs) */
+    blocks: string[];
+    /** Status */
+    status: FixStatus;
+    /** Assigned to */
+    assignedTo?: string;
+    /** Due date */
+    dueDate?: Date;
+}
+/**
+ * Fix status
+ */
+export type FixStatus = 'pending' | 'in-progress' | 'testing' | 'completed' | 'blocked' | 'skipped';
+/**
+ * Fix dependency
+ */
+export interface FixDependency {
+    /** Source fix ID */
+    fixId: string;
+    /** Depends on fix ID */
+    dependsOn: string;
+    /** Dependency type */
+    type: DependencyType;
+    /** Reason */
+    reason: string;
+}
+/**
+ * Dependency type
+ */
+export type DependencyType = 'requires' | 'conflicts' | 'enhances' | 'supersedes';
+/**
+ * Effort estimate
+ */
+export interface EffortEstimate {
+    /** Estimated hours */
+    hours: number;
+    /** Confidence (0-1) */
+    confidence: number;
+    /** Complexity */
+    complexity: 'low' | 'medium' | 'high' | 'very-high';
+    /** Testing hours */
+    testingHours: number;
+    /** Review hours */
+    reviewHours: number;
+}
+/**
+ * Duration
+ */
+export interface Duration {
+    /** Value */
+    value: number;
+    /** Unit */
+    unit: 'hours' | 'days' | 'weeks';
+}
+/**
+ * Risk reduction
+ */
+export interface RiskReduction {
+    /** Initial risk score */
+    initialRisk: number;
+    /** Final risk score */
+    finalRisk: number;
+    /** Reduction percentage */
+    reductionPercent: number;
+    /** Critical vulnerabilities fixed */
+    criticalFixed: number;
+    /** High vulnerabilities fixed */
+    highFixed: number;
+    /** Medium vulnerabilities fixed */
+    mediumFixed: number;
+    /** Low vulnerabilities fixed */
+    lowFixed: number;
+}
+/**
+ * Risk level
+ */
+export type RiskLevel = 'critical' | 'high' | 'medium' | 'low' | 'minimal';
+/**
+ * Plan metadata
+ */
+export interface PlanMetadata {
+    /** Author */
+    author?: string;
+    /** Approved by */
+    approvedBy?: string;
+    /** Approval date */
+    approvalDate?: Date;
+    /** Target completion */
+    targetCompletion?: Date;
+    /** Notes */
+    notes?: string[];
+    /** Tags */
+    tags?: string[];
+}
+/**
+ * Prioritization strategy
+ */
+export type PrioritizationStrategy = 'severity-first' | 'effort-first' | 'risk-based' | 'dependency-aware' | 'balanced';
+/**
+ * Planner options
+ */
+export interface RemediationPlannerOptions {
+    /** Default prioritization strategy */
+    defaultStrategy?: PrioritizationStrategy;
+    /** Max fixes per phase */
+    maxFixesPerPhase?: number;
+    /** Include effort estimates */
+    includeEffortEstimates?: boolean;
+    /** Team size for effort calculation */
+    teamSize?: number;
+}
+/**
+ * Planning options
+ */
+export interface PlanningOptions {
+    /** Prioritization strategy */
+    strategy?: PrioritizationStrategy;
+    /** Max phases */
+    maxPhases?: number;
+    /** Group by file */
+    groupByFile?: boolean;
+    /** Exclude severities */
+    excludeSeverities?: string[];
+    /** Target completion date */
+    targetDate?: Date;
+}
+/**
+ * Planner for vulnerability remediation
+ *
+ * @example
+ * ```typescript
+ * const planner = createRemediationPlanner();
+ * const plan = planner.createPlan(scanResult, fixes, { strategy: 'risk-based' });
+ * console.log(plan.phases.length); // Number of remediation phases
+ * ```
+ */
+export declare class RemediationPlanner {
+    private options;
+    constructor(options?: RemediationPlannerOptions);
+    /**
+     * Create a remediation plan
+     */
+    createPlan(scanResult: ScanResult, fixes: Fix[], options?: PlanningOptions): RemediationPlan;
+    /**
+     * Update plan status
+     */
+    updatePlanStatus(plan: RemediationPlan, status: PlanStatus): RemediationPlan;
+    /**
+     * Mark a fix as completed
+     */
+    markFixCompleted(plan: RemediationPlan, fixId: string): RemediationPlan;
+    /**
+     * Get next fixes to work on
+     */
+    getNextFixes(plan: RemediationPlan, count?: number): PlannedFix[];
+    /**
+     * Calculate plan progress
+     */
+    calculateProgress(plan: RemediationPlan): {
+        totalFixes: number;
+        completedFixes: number;
+        percentComplete: number;
+        currentPhase: number;
+    };
+    /**
+     * Generate remediation report
+     */
+    generateReport(plan: RemediationPlan): string;
+    private createPlannedFixes;
+    private detectDependencies;
+    private rangesOverlap;
+    private prioritize;
+    private createPhases;
+    private generatePhaseName;
+    private formatType;
+    private generatePhaseDescription;
+    private estimatePhaseDuration;
+    private calculateResidualRisk;
+    private calculatePriorityScore;
+    private estimateEffort;
+    private calculateTotalEffort;
+    private calculateRiskReduction;
+}
+/**
+ * Create a remediation planner
+ */
+export declare function createRemediationPlanner(options?: RemediationPlannerOptions): RemediationPlanner;
+/**
+ * Quick create a plan from scan results
+ */
+export declare function quickCreatePlan(scanResult: ScanResult, fixes: Fix[]): RemediationPlan;
+//# sourceMappingURL=remediation-planner.d.ts.map

package/dist/remediation/remediation-planner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remediation-planner.d.ts","sourceRoot":"","sources":["../../src/remediation/remediation-planner.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAMxE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,cAAc;IACd,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,SAAS,EAAE,IAAI,CAAC;IAChB,kBAAkB;IAClB,MAAM,EAAE,UAAU,CAAC;IACnB,4BAA4B;IAC5B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,qBAAqB;IACrB,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,uBAAuB;IACvB,eAAe,EAAE,cAAc,CAAC;IAChC,qBAAqB;IACrB,aAAa,EAAE,aAAa,CAAC;IAC7B,iCAAiC;IACjC,YAAY,EAAE,aAAa,EAAE,CAAC;IAC9B,eAAe;IACf,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,UAAU,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,CAAC;AAE1F;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,0BAA0B;IAC1B,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,yBAAyB;IACzB,iBAAiB,EAAE,QAAQ,CAAC;IAC5B,oBAAoB;IACpB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,6BAA6B;IAC7B,YAAY,EAAE,SAAS,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,oBAAoB;IACpB,GAAG,EAAE,GAAG,CAAC;IACT,8BAA8B;IAC9B,aAAa,EAAE,aAAa,CAAC;IAC7B,qBAAqB;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,sBAAsB;IACtB,MAAM,EAAE,cAAc,CAAC;IACvB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,uBAAuB;IACvB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,aAAa;IACb,MAAM,EAAE,SAAS,CAAC;IAClB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe;IACf,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,aAAa,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,CAAC;AAEpG;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,sBAAsB;IACtB,IAAI,EAAE,cAAc,CAAC;IACrB,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,WAAW,GAAG,UAAU,GAAG,YAAY,CAAC;AAElF;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,sBAAsB;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB;IACjB,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;IACpD,oBAAoB;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW;IACX,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,yBAAyB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,qCAAqC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,aAAa;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oBAAoB;IACpB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,wBAAwB;IACxB,gBAAgB,CAAC,EAAE,IAAI,CAAC;IACxB,YAAY;IACZ,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,gBAAgB,GAChB,cAAc,GACd,YAAY,GACZ,kBAAkB,GAClB,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,sCAAsC;IACtC,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC,0BAA0B;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,+BAA+B;IAC/B,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,yBAAyB;IACzB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,6BAA6B;IAC7B,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB;AAMD;;;;;;;;;GASG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,OAAO,CAAsC;gBAEzC,OAAO,GAAE,yBAA8B;IASnD;;OAEG;IACH,UAAU,CACR,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,GAAG,EAAE,EACZ,OAAO,GAAE,eAAoB,GAC5B,eAAe;IAoClB;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,UAAU,GAAG,eAAe;IAW5E;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,eAAe;IAsBvE;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,GAAE,MAAU,GAAG,UAAU,EAAE;IAgBpE;;OAEG;IACH,iBAAiB,CAAC,IAAI,EAAE,eAAe,GAAG;QACxC,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,MAAM,CAAC;QACvB,eAAe,EAAE,MAAM,CAAC;QACxB,YAAY,EAAE,MAAM,CAAC;KACtB;IA6BD;;OAEG;IACH,cAAc,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM;IAkE7C,OAAO,CAAC,kBAAkB;IAyB1B,OAAO,CAAC,kBAAkB;IAoE1B,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,UAAU;IA8DlB,OAAO,CAAC,YAAY;IA4DpB,OAAO,CAAC,iBAAiB;IAgCzB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,wBAAwB;IAOhC,OAAO,CAAC,qBAAqB;IAa7B,OAAO,CAAC,qBAAqB;IAW7B,OAAO,CAAC,sBAAsB;IAa9B,OAAO,CAAC,cAAc;IAsCtB,OAAO,CAAC,oBAAoB;IAmB5B,OAAO,CAAC,sBAAsB;CAwB/B;AAMD;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,kBAAkB,CAEhG;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,GAAG,EAAE,GACX,eAAe,CAGjB"}