@cyclonedx/cdxgen/types/lib/audit/index.d.ts

Creates CycloneDX Software Bill of Materials (SBOM) from source or container image

export declare const DEFAULT_AUDIT_CATEGORIES: string[];
/**
 * Read and validate a CycloneDX BOM file.
 *
 * @param {string} bomPath BOM file path
 * @returns {object} parsed CycloneDX BOM
 */
export declare function loadBomFile(bomPath: string): object;
/**
 * Recursively list JSON files under a BOM directory.
 *
 * @param {string} bomDir directory path
 * @returns {string[]} discovered file paths
 */
export declare function listBomFiles(bomDir: string): string[];
/**
 * Load input BOM files from either a single file or a directory.
 *
 * @param {object} options CLI options
 * @returns {{ source: string, bomJson: object }[]} loaded input BOMs
 */
export declare function loadInputBoms(options: object): {
    source: string;
    bomJson: object;
}[];
export declare function runDirectBomAuditFromBoms(inputBoms: any, options?: {}): Promise<{
    auditMode: string;
    generatedAt: string;
    inputs: any;
    results: {
        auditOptions: {
            aiProvenance: any;
            bomAuditCategories: any;
            bomAuditMinSeverity: any;
            bomAuditRulesDir: any;
            workspaceDir: any;
        };
        bomFormat: any;
        findings: any[];
        serialNumber: any;
        source: any;
        specVersion: any;
        status: string;
        summary: {
            findingsBySeverity: {
                critical: number;
                high: number;
                low: number;
                medium: number;
            };
            findingsCount: number;
            maxSeverity: string;
        };
    }[];
    summary: {
        findingsBySeverity: {
            critical: number;
            high: number;
            low: number;
            medium: number;
        };
        inputBomCount: any;
        maxSeverity: string;
        totalFindings: number;
        bomsWithFindings: number;
    };
    tool: {
        name: string;
        version: string;
    };
}>;
/**
 * Build low-noise provenance-aware contextual findings from the root BOM target.
 *
 * These are intentionally conservative and only fire when there is explicit risk
 * posture already present in the target metadata.
 *
 * @param {object} target audit target
 * @returns {object[]} contextual findings
 */
export declare function buildTargetContextFindings(target: object): object[];
/**
 * Resolve the most specific Python package directory inside a cloned repo.
 *
 * @param {string} cloneDir cloned repository root
 * @param {object} target audit target
 * @returns {{ confidence: string, scanDir: string }} selected directory and confidence
 */
export declare function resolvePythonSourceDirectory(cloneDir: string, target: object): {
    confidence: string;
    scanDir: string;
};
/**
 * Resolve the most appropriate scan directory for a cloned target repository.
 *
 * @param {string} cloneDir cloned repository root
 * @param {object} target audit target
 * @param {object} resolution repository resolution metadata
 * @returns {{ confidence: string, scanDir: string }} selected directory and confidence
 */
export declare function resolveTargetSourceDirectory(cloneDir: string, target: object, resolution: object): {
    confidence: string;
    scanDir: string;
};
/**
 * Build shallow predictive findings for suspicious Python packaging files.
 *
 * Phase 1 intentionally focuses on high-signal packaging surfaces (`setup.py`
 * and package `__init__.py`) until deeper Python static analysis is added.
 *
 * @param {string} scanDir cloned repository scan directory
 * @param {object} target audit target
 * @returns {object[]} predictive findings
 */
export declare function buildPythonSourceHeuristicFindings(scanDir: string, target: object): object[];
/**
 * Analyze a single purl target by generating a child SBOM and auditing it.
 *
 * @param {object} target audit target
 * @param {object} options CLI options
 * @returns {Promise<object>} analyzed target result
 */
export declare function auditTarget(target: object, options: object): Promise<object>;
export declare function groupAuditResults(results: any): any[];
/**
 * Run the predictive audit flow from one or more already-loaded CycloneDX BOM inputs.
 *
 * @param {{ source: string, bomJson: object }[]} inputBoms loaded CycloneDX BOM objects
 * @param {object} options CLI options
 * @returns {Promise<object>} aggregate audit report
 */
export declare function runAuditFromBoms(inputBoms: {
    source: string;
    bomJson: object;
}[], options: object): Promise<object>;
/**
 * Run the predictive audit flow from one or more CycloneDX BOM inputs.
 *
 * @param {object} options CLI options
 * @returns {Promise<object>} aggregate audit report
 */
export declare function runAudit(options: object): Promise<object>;
/**
 * Aggregates license compliance violations onto the report. Violations come
 * from two sources: the input BOM(s) directly, and — in predictive mode — the
 * per-dependency child SBOMs generated from cloned upstream sources (carried on
 * each target result). Duplicates across both are collapsed so the same
 * component/license/alert is reported once. No-op without a policy.
 *
 * @param {object} report aggregate audit report (mutated)
 * @param {object[]} inputBoms loaded input BOMs
 * @param {object|null} policy preloaded compliance policy
 * @returns {void}
 */
export declare function attachLicenseViolations(report: object, inputBoms: object[], policy: object | null): void;
/**
 * Render a report and compute the proper process exit code.
 *
 * @param {object} report aggregate report
 * @param {object} options CLI options
 * @returns {{ exitCode: number, output: string }} rendered output and exit code
 */
export declare function finalizeAuditReport(report: object, options: object): {
    exitCode: number;
    output: string;
};
/**
 * Build a result file name for user-provided report output paths.
 *
 * @param {object} options CLI options
 * @returns {string | undefined} output file path
 */
export declare function defaultOutputFile(options: object): string | undefined;
//# sourceMappingURL=index.d.ts.map