@herodevs/cli 2.0.0-beta.3 → 2.0.0-beta.5

package/dist/api/types/hd-cli.types.d.ts

@@ -1,31 +0,0 @@
-import { type ComponentStatus, type InsightsEolScanComponent, type ScanWarning } from './nes.types.ts';
-export declare const isValidComponentStatus: (status: string) => status is ComponentStatus;
-export interface ScanInputOptions {
-    type: 'SBOM' | 'OTHER';
-    page: number;
-    totalPages: number;
-    scanId?: string;
-}
-export declare const DEFAULT_SCAN_BATCH_SIZE = 1000;
-export declare const DEFAULT_SCAN_INPUT_OPTIONS: ScanInputOptions;
-export type ScanResultComponentsMap = Map<string, InsightsEolScanComponent>;
-export type ScanInput = {
-    components: string[];
-    options: ScanInputOptions;
-};
-export interface ScanResult {
-    components: ScanResultComponentsMap;
-    createdOn?: string;
-    diagnostics?: Record<string, unknown>;
-    message: string;
-    success: boolean;
-    warnings: ScanWarning[];
-    scanId: string | undefined;
-}
-export interface ProcessBatchOptions {
-    batch: string[];
-    index: number;
-    totalPages: number;
-    scanOptions: ScanInputOptions;
-    previousScanId?: string;
-}

package/dist/api/types/hd-cli.types.js

@@ -1,10 +0,0 @@
-import { VALID_STATUSES } from "./nes.types.js";
-export const isValidComponentStatus = (status) => {
-    return VALID_STATUSES.includes(status);
-};
-export const DEFAULT_SCAN_BATCH_SIZE = 1000;
-export const DEFAULT_SCAN_INPUT_OPTIONS = {
-    type: 'SBOM',
-    page: 1,
-    totalPages: 1,
-};

package/dist/api/types/nes.types.d.ts

@@ -1,54 +0,0 @@
-/**
- * Input parameters for the EOL scan operation
- */
-export interface InsightsEolScanInput {
-    scanId?: string;
-    /** Array of package URLs in purl format to scan */
-    components: string[];
-    /** The type of scan being performed (e.g. 'SBOM') */
-    type: string;
-    page: number;
-    totalPages: number;
-}
-export interface ScanResponse {
-    insights: {
-        scan: {
-            eol: InsightsEolScanResult;
-        };
-    };
-}
-/**
- * Result of the EOL scan operation
- */
-export interface InsightsEolScanResult {
-    scanId?: string;
-    createdOn: string;
-    success: boolean;
-    message: string;
-    components: InsightsEolScanComponent[];
-    warnings: ScanWarning[];
-}
-/**
- * Information about a component's EOL status
- */
-export interface InsightsEolScanComponentInfo {
-    isEol: boolean;
-    isUnsafe: boolean;
-    eolAt: Date | null;
-    status: ComponentStatus;
-    daysEol: number | null;
-    vulnCount: number | null;
-}
-export interface InsightsEolScanComponent {
-    info: InsightsEolScanComponentInfo;
-    purl: string;
-}
-export interface ScanWarning {
-    purl: string;
-    message: string;
-    type?: string;
-    error?: unknown;
-    diagnostics?: Record<string, unknown>;
-}
-export type ComponentStatus = (typeof VALID_STATUSES)[number];
-export declare const VALID_STATUSES: readonly ["UNKNOWN", "OK", "EOL", "SUPPORTED"];

package/dist/api/types/nes.types.js

@@ -1 +0,0 @@
-export const VALID_STATUSES = ['UNKNOWN', 'OK', 'EOL', 'SUPPORTED'];

package/dist/commands/report/committers.d.ts

@@ -1,23 +0,0 @@
-import { Command } from '@oclif/core';
-import { type ReportData } from '../../service/committers.svc.ts';
-export default class Committers extends Command {
-    static description: string;
-    static enableJsonFlag: boolean;
-    static examples: string[];
-    static flags: {
-        months: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
-        csv: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        save: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-    };
-    run(): Promise<ReportData | string>;
-    /**
-     * Generates structured report data
-     * @param entries - parsed git log output for commits
-     */
-    private generateReportData;
-    /**
-     * Fetches git commit data with month and author information
-     * @param sinceDate - Date range for git log
-     */
-    private fetchGitCommitData;
-}

package/dist/commands/report/committers.js

@@ -1,146 +0,0 @@
-import { spawnSync } from 'node:child_process';
-import { Command, Flags } from '@oclif/core';
-import fs from 'node:fs';
-import path from 'node:path';
-import { calculateOverallStats, formatAsCsv, formatAsText, groupCommitsByMonth, parseGitLogOutput, } from "../../service/committers.svc.js";
-import { getErrorMessage, isErrnoException } from "../../service/error.svc.js";
-export default class Committers extends Command {
-    static description = 'Generate report of committers to a git repository';
-    static enableJsonFlag = true;
-    static examples = [
-        '<%= config.bin %> <%= command.id %>',
-        '<%= config.bin %> <%= command.id %> --csv -s',
-        '<%= config.bin %> <%= command.id %> --json',
-        '<%= config.bin %> <%= command.id %> --csv',
-    ];
-    static flags = {
-        months: Flags.integer({
-            char: 'm',
-            description: 'The number of months of git history to review',
-            default: 12,
-        }),
-        csv: Flags.boolean({
-            char: 'c',
-            description: 'Output in CSV format',
-            default: false,
-        }),
-        save: Flags.boolean({
-            char: 's',
-            description: 'Save the committers report as eol.committers.<output>',
-            default: false,
-        }),
-    };
-    async run() {
-        const { flags } = await this.parse(Committers);
-        const { months, csv, save } = flags;
-        const isJson = this.jsonEnabled();
-        const sinceDate = `${months} months ago`;
-        this.log('Starting committers report with flags: %O', flags);
-        try {
-            // Generate structured report data
-            const entries = this.fetchGitCommitData(sinceDate);
-            this.log('Fetched %d commit entries', entries.length);
-            const reportData = this.generateReportData(entries);
-            // Handle different output scenarios
-            if (isJson) {
-                // JSON mode
-                if (save) {
-                    try {
-                        fs.writeFileSync(path.resolve('eol.committers.json'), JSON.stringify(reportData, null, 2));
-                        this.log('Report written to json');
-                    }
-                    catch (error) {
-                        this.error(`Failed to save JSON report: ${getErrorMessage(error)}`);
-                    }
-                }
-                return reportData;
-            }
-            const textOutput = formatAsText(reportData);
-            if (csv) {
-                // CSV mode
-                const csvOutput = formatAsCsv(reportData);
-                if (save) {
-                    try {
-                        fs.writeFileSync(path.resolve('eol.committers.csv'), csvOutput);
-                        this.log('Report written to csv');
-                    }
-                    catch (error) {
-                        this.error(`Failed to save CSV report: ${getErrorMessage(error)}`);
-                    }
-                }
-                else {
-                    this.log(textOutput);
-                }
-                return csvOutput;
-            }
-            if (save) {
-                try {
-                    fs.writeFileSync(path.resolve('eol.committers.txt'), textOutput);
-                    this.log('Report written to txt');
-                }
-                catch (error) {
-                    this.error(`Failed to save txt report: ${getErrorMessage(error)}`);
-                }
-            }
-            else {
-                this.log(textOutput);
-            }
-            return textOutput;
-        }
-        catch (error) {
-            this.error(`Failed to generate report: ${getErrorMessage(error)}`);
-        }
-    }
-    /**
-     * Generates structured report data
-     * @param entries - parsed git log output for commits
-     */
-    generateReportData(entries) {
-        if (entries.length === 0) {
-            return { monthly: {}, overall: { total: 0 } };
-        }
-        const monthlyData = groupCommitsByMonth(entries);
-        const overallStats = calculateOverallStats(entries);
-        const grandTotal = entries.length;
-        // Format into a structured report data object
-        const report = {
-            monthly: {},
-            overall: { ...overallStats, total: grandTotal },
-        };
-        // Add monthly totals
-        for (const [month, authors] of Object.entries(monthlyData)) {
-            const monthTotal = Object.values(authors).reduce((sum, count) => sum + count, 0);
-            report.monthly[month] = { ...authors, total: monthTotal };
-        }
-        return report;
-    }
-    /**
-     * Fetches git commit data with month and author information
-     * @param sinceDate - Date range for git log
-     */
-    fetchGitCommitData(sinceDate) {
-        const logProcess = spawnSync('git', [
-            'log',
-            '--all', // Include committers on all branches in the repo
-            '--format="%ad|%an"', // Format: date|author
-            '--date=format:%Y-%m', // Format date as YYYY-MM
-            `--since="${sinceDate}"`,
-        ], { encoding: 'utf-8' });
-        if (logProcess.error) {
-            if (isErrnoException(logProcess.error)) {
-                if (logProcess.error.code === 'ENOENT') {
-                    this.error('Git command not found. Please ensure git is installed and available in your PATH.');
-                }
-                this.error(`Git command failed: ${getErrorMessage(logProcess.error)}`);
-            }
-            this.error(`Git command failed: ${getErrorMessage(logProcess.error)}`);
-        }
-        if (logProcess.status !== 0) {
-            this.error(`Git command failed with status ${logProcess.status}: ${logProcess.stderr}`);
-        }
-        if (!logProcess.stdout) {
-            return [];
-        }
-        return parseGitLogOutput(logProcess.stdout);
-    }
-}

package/dist/commands/report/purls.d.ts

@@ -1,15 +0,0 @@
-import { Command } from '@oclif/core';
-export default class ReportPurls extends Command {
-    static description: string;
-    static enableJsonFlag: boolean;
-    static examples: string[];
-    static flags: {
-        file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        dir: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        save: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        csv: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-    };
-    run(): Promise<{
-        purls: string[];
-    }>;
-}

package/dist/commands/report/purls.js

@@ -1,84 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { Command, Flags, ux } from '@oclif/core';
-import { getErrorMessage, isErrnoException } from "../../service/error.svc.js";
-import { extractPurls, getPurlOutput } from "../../service/purls.svc.js";
-import ScanSbom from "../scan/sbom.js";
-export default class ReportPurls extends Command {
-    static description = 'Generate a list of purls from a sbom';
-    static enableJsonFlag = true;
-    static examples = [
-        '<%= config.bin %> <%= command.id %> --json -s',
-        '<%= config.bin %> <%= command.id %> --dir=./my-project',
-        '<%= config.bin %> <%= command.id %> --file=path/to/sbom.json',
-        '<%= config.bin %> <%= command.id %> --dir=./my-project --save',
-        '<%= config.bin %> <%= command.id %> --save --csv',
-    ];
-    static flags = {
-        file: Flags.string({
-            char: 'f',
-            description: 'The file path of an existing cyclonedx sbom to scan for EOL',
-        }),
-        dir: Flags.string({
-            char: 'd',
-            description: 'The directory to scan in order to create a cyclonedx sbom',
-        }),
-        save: Flags.boolean({
-            char: 's',
-            default: false,
-            description: 'Save the list of purls as eol.purls.<output>',
-        }),
-        csv: Flags.boolean({
-            char: 'c',
-            default: false,
-            description: 'Save output in CSV format (only applies when using --save)',
-        }),
-    };
-    async run() {
-        const { flags } = await this.parse(ReportPurls);
-        const { dir: _dirFlag, file: _fileFlag, save, csv } = flags;
-        try {
-            const sbom = await ScanSbom.loadSbom(flags, this.config);
-            const purls = await extractPurls(sbom);
-            this.log('Extracted %d purls from SBOM', purls.length);
-            ux.action.stop('Scan completed');
-            // Print the purls
-            for (const purl of purls) {
-                this.log(purl);
-            }
-            // Save if requested
-            if (save) {
-                try {
-                    const outputFile = csv && !this.jsonEnabled() ? 'csv' : 'json';
-                    const outputPath = path.join(_dirFlag || process.cwd(), `eol.purls.${outputFile}`);
-                    const purlOutput = getPurlOutput(purls, outputFile);
-                    fs.writeFileSync(outputPath, purlOutput);
-                    this.log('Purls saved to %s', outputPath);
-                }
-                catch (error) {
-                    if (isErrnoException(error)) {
-                        switch (error.code) {
-                            case 'EACCES':
-                                this.error('Permission denied: Cannot write to output file');
-                                break;
-                            case 'ENOSPC':
-                                this.error('No space left on device');
-                                break;
-                            case 'EISDIR':
-                                this.error('Cannot write to output file: Is a directory');
-                                break;
-                            default:
-                                this.error(`Failed to save purls: ${getErrorMessage(error)}`);
-                        }
-                    }
-                    this.error(`Failed to save purls: ${getErrorMessage(error)}`);
-                }
-            }
-            // Return wrapped object with metadata
-            return { purls };
-        }
-        catch (error) {
-            this.error(`Failed to generate PURLs: ${getErrorMessage(error)}`);
-        }
-    }
-}

package/dist/commands/scan/sbom.d.ts

@@ -1,21 +0,0 @@
-import { Command } from '@oclif/core';
-import type { Sbom } from '../../service/eol/cdx.svc.ts';
-export default class ScanSbom extends Command {
-    static description: string;
-    static enableJsonFlag: boolean;
-    static examples: string[];
-    static flags: {
-        file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        dir: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        save: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        background: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-    };
-    static loadSbom(flags: Record<string, string>, config: Command['config']): Promise<Sbom>;
-    static getSbomArgs(flags: Record<string, string>): string[];
-    getScanOptions(): {};
-    run(): Promise<Sbom | undefined>;
-    private _getSbomFromScan;
-    private _getSbomInBackground;
-    private _getSbomFromFile;
-    private _saveSbom;
-}

package/dist/commands/scan/sbom.js

@@ -1,159 +0,0 @@
-import { spawn } from 'node:child_process';
-import fs from 'node:fs';
-import { join, resolve } from 'node:path';
-import { Command, Flags, ux } from '@oclif/core';
-import { createSbom, validateIsCycloneDxSbom } from "../../service/eol/eol.svc.js";
-import { getErrorMessage } from "../../service/error.svc.js";
-export default class ScanSbom extends Command {
-    static description = 'Scan a SBOM for purls';
-    static enableJsonFlag = true;
-    static examples = [
-        '<%= config.bin %> <%= command.id %> --dir=./my-project',
-        '<%= config.bin %> <%= command.id %> --file=path/to/sbom.json',
-    ];
-    static flags = {
-        file: Flags.string({
-            char: 'f',
-            description: 'The file path of an existing cyclonedx sbom to scan for EOL',
-        }),
-        dir: Flags.string({
-            char: 'd',
-            description: 'The directory to scan in order to create a cyclonedx sbom',
-        }),
-        save: Flags.boolean({
-            char: 's',
-            default: false,
-            description: 'Save the generated SBOM as eol.sbom.json in the scanned directory',
-        }),
-        background: Flags.boolean({
-            char: 'b',
-            default: false,
-            description: 'Run the scan in the background',
-        }),
-    };
-    static async loadSbom(flags, config) {
-        const sbomArgs = ScanSbom.getSbomArgs(flags);
-        const sbomCommand = new ScanSbom(sbomArgs, config);
-        const sbom = await sbomCommand.run();
-        if (!sbom) {
-            throw new Error('SBOM not generated');
-        }
-        return sbom;
-    }
-    static getSbomArgs(flags) {
-        const { dir, file, save, json, background } = flags ?? {};
-        const sbomArgs = [];
-        if (file)
-            sbomArgs.push('--file', file);
-        if (dir)
-            sbomArgs.push('--dir', dir);
-        // if (save) sbomArgs.push('--save'); // only save if sbom command is used directly with -s flag
-        if (json)
-            sbomArgs.push('--json');
-        if (background)
-            sbomArgs.push('--background');
-        return sbomArgs;
-    }
-    getScanOptions() {
-        // intentionally provided for mocking
-        return {};
-    }
-    async run() {
-        const { flags } = await this.parse(ScanSbom);
-        const { dir, save, file, background } = flags;
-        // Validate that exactly one of --file or --dir is provided
-        if (file && dir) {
-            this.error('Cannot specify both --file and --dir flags. Please use one or the other.');
-        }
-        let sbom;
-        const path = dir || process.cwd();
-        if (file) {
-            sbom = this._getSbomFromFile(file);
-        }
-        else if (background) {
-            this._getSbomInBackground(path);
-            this.log(`The scan is running in the background. The file will be saved at ${path}/eol.sbom.json`);
-            return;
-        }
-        else {
-            sbom = await this._getSbomFromScan(path);
-            if (save) {
-                this._saveSbom(path, sbom);
-            }
-        }
-        return sbom;
-    }
-    async _getSbomFromScan(_dirFlag) {
-        const dir = resolve(_dirFlag);
-        try {
-            if (!fs.existsSync(dir)) {
-                this.error(`Directory not found: ${dir}`);
-            }
-            const stats = fs.statSync(dir);
-            if (!stats.isDirectory()) {
-                this.error(`Path is not a directory: ${dir}`);
-            }
-            ux.action.start(`Scanning ${dir}`);
-            const options = this.getScanOptions();
-            const sbom = await createSbom(dir, options);
-            if (!sbom) {
-                this.error(`SBOM failed to generate for dir: ${dir}`);
-            }
-            return sbom;
-        }
-        catch (error) {
-            this.error(`Failed to scan directory: ${getErrorMessage(error)}`);
-        }
-    }
-    _getSbomInBackground(path) {
-        try {
-            const opts = this.getScanOptions();
-            const args = [
-                JSON.stringify({
-                    opts,
-                    path,
-                }),
-            ];
-            const workerProcess = spawn('node', [join(import.meta.url, '../../service/eol/sbom.worker.js'), ...args], {
-                stdio: 'ignore',
-                detached: true,
-                env: { ...process.env },
-            });
-            workerProcess.unref();
-        }
-        catch (error) {
-            this.error(`Failed to start background scan: ${getErrorMessage(error)}`);
-        }
-    }
-    _getSbomFromFile(_fileFlag) {
-        const file = resolve(_fileFlag);
-        try {
-            if (!fs.existsSync(file)) {
-                this.error(`SBOM file not found: ${file}`);
-            }
-            ux.action.start(`Loading sbom from ${file}`);
-            const fileContent = fs.readFileSync(file, {
-                encoding: 'utf8',
-                flag: 'r',
-            });
-            const sbom = JSON.parse(fileContent);
-            validateIsCycloneDxSbom(sbom);
-            return sbom;
-        }
-        catch (error) {
-            this.error(`Failed to read SBOM file: ${getErrorMessage(error)}`);
-        }
-    }
-    _saveSbom(dir, sbom) {
-        try {
-            const outputPath = join(dir, 'eol.sbom.json');
-            fs.writeFileSync(outputPath, JSON.stringify(sbom, null, 2));
-            if (!this.jsonEnabled()) {
-                this.log(`SBOM saved to ${outputPath}`);
-            }
-        }
-        catch (error) {
-            this.error(`Failed to save SBOM: ${getErrorMessage(error)}`);
-        }
-    }
-}

package/dist/service/committers.svc.d.ts

@@ -1,70 +0,0 @@
-export interface CommitEntry {
-    month: string;
-    author: string;
-}
-export interface AuthorCommitCounts {
-    [author: string]: number;
-}
-export interface MonthlyData {
-    [month: string]: AuthorCommitCounts;
-}
-export interface ReportData {
-    monthly: {
-        [month: string]: {
-            [author: string]: number;
-            total: number;
-        };
-    };
-    overall: {
-        [author: string]: number;
-        total: number;
-    };
-}
-/**
- * Parses git log output into structured data
- * @param output - Git log command output
- * @returns Parsed commit entries
- */
-export declare function parseGitLogOutput(output: string): CommitEntry[];
-/**
- * Groups commit data by month
- * @param entries - Commit entries
- * @returns Object with months as keys and author commit counts as values
- */
-export declare function groupCommitsByMonth(entries: CommitEntry[]): MonthlyData;
-/**
- * Calculates overall commit statistics by author
- * @param entries - Commit entries
- * @returns Object with authors as keys and total commit counts as values
- */
-export declare function calculateOverallStats(entries: CommitEntry[]): AuthorCommitCounts;
-/**
- * Formats monthly report sections
- * @param monthlyData - Grouped commit data by month
- * @returns Formatted monthly report sections
- */
-export declare function formatMonthlyReport(monthlyData: MonthlyData): string;
-/**
- * Formats overall statistics section
- * @param overallStats - Overall commit counts by author
- * @param grandTotal - Total number of commits
- * @returns Formatted overall statistics section
- */
-export declare function formatOverallStats(overallStats: AuthorCommitCounts, grandTotal: number): string;
-/**
- * Formats the report data as CSV
- * @param data - The structured report data
- */
-export declare function formatAsCsv(data: ReportData): string;
-/**
- * Formats the report data as text
- * @param data - The structured report data
- */
-export declare function formatAsText(data: ReportData): string;
-/**
- * Format output based on user preference
- * @param output
- * @param reportData
- * @returns
- */
-export declare function formatOutputBasedOnFlag(output: string, reportData: ReportData): string;