@herodevs/cli 2.0.0-beta.1 → 2.0.0-beta.11

package/dist/api/client.js

@@ -1,43 +0,0 @@
-import * as apollo from '@apollo/client/core/index.js';
-import { ApolloError } from "../service/error.svc.js";
-export const createApollo = (url) => new apollo.ApolloClient({
-    cache: new apollo.InMemoryCache({
-        addTypename: false,
-    }),
-    headers: {
-        'User-Agent': `hdcli/${process.env.npm_package_version ?? 'unknown'}`,
-    },
-    link: apollo.ApolloLink.from([
-        new apollo.HttpLink({
-            uri: url,
-        }),
-    ]),
-});
-export class ApolloClient {
-    #apollo;
-    constructor(url) {
-        this.#apollo = createApollo(url);
-    }
-    async mutate(mutation, variables) {
-        try {
-            return await this.#apollo.mutate({
-                mutation,
-                variables,
-            });
-        }
-        catch (error) {
-            throw new ApolloError('GraphQL mutation failed', error);
-        }
-    }
-    async query(query, variables) {
-        try {
-            return await this.#apollo.query({
-                query,
-                variables,
-            });
-        }
-        catch (error) {
-            throw new ApolloError('GraphQL query failed', error);
-        }
-    }
-}

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

@@ -1,23 +0,0 @@
-import type * as apollo from '@apollo/client/core/index.js';
-import type { InsightsEolScanInput, InsightsEolScanResult } from '../../api/types/nes.types.ts';
-import { type ProcessBatchOptions, type ScanInputOptions, type ScanResult } from '../types/hd-cli.types.ts';
-export interface NesClient {
-    scan: {
-        purls: (purls: string[], options: ScanInputOptions) => Promise<InsightsEolScanResult>;
-    };
-}
-export declare class NesApolloClient implements NesClient {
-    #private;
-    scan: {
-        purls: (purls: string[], options: ScanInputOptions) => Promise<InsightsEolScanResult>;
-    };
-    constructor(url: string);
-    mutate<T, V extends Record<string, unknown>>(mutation: apollo.DocumentNode, variables?: V): Promise<apollo.FetchResult<T>>;
-    query<T, V extends Record<string, unknown> | undefined>(query: apollo.DocumentNode, variables?: V): Promise<apollo.ApolloQueryResult<T>>;
-}
-export declare const batchSubmitPurls: (purls: string[], options?: ScanInputOptions, batchSize?: number) => Promise<ScanResult>;
-export declare const createBatches: (items: string[], batchSize: number) => string[][];
-export declare const processBatch: ({ batch, index, totalPages, scanOptions, previousScanId, }: ProcessBatchOptions) => Promise<InsightsEolScanResult>;
-export declare const processBatches: (batches: string[][], scanOptions: ScanInputOptions) => Promise<InsightsEolScanResult[]>;
-export declare const handleBatchResults: (results: InsightsEolScanResult[]) => ScanResult;
-export declare const buildInsightsEolScanInput: (purls: string[], options: ScanInputOptions) => InsightsEolScanInput;

package/dist/api/nes/nes.client.js

@@ -1,107 +0,0 @@
-import { ApolloClient } from "../../api/client.js";
-import { config } from "../../config/constants.js";
-import { debugLogger } from "../../service/log.svc.js";
-import { SbomScanner, buildScanResult } from "../../service/nes/nes.svc.js";
-import { DEFAULT_SCAN_BATCH_SIZE, DEFAULT_SCAN_INPUT_OPTIONS, } from "../types/hd-cli.types.js";
-export class NesApolloClient {
-    scan = {
-        purls: SbomScanner(this),
-    };
-    #apollo;
-    constructor(url) {
-        this.#apollo = new ApolloClient(url);
-    }
-    mutate(mutation, variables) {
-        return this.#apollo.mutate(mutation, variables);
-    }
-    query(query, variables) {
-        return this.#apollo.query(query, variables);
-    }
-}
-/**
- * Submit a scan for a list of purls after they've been batched by batchSubmitPurls
- */
-function submitScan(purls, options) {
-    const host = config.graphqlHost;
-    const path = config.graphqlPath;
-    const url = host + path;
-    const client = new NesApolloClient(url);
-    return client.scan.purls(purls, options);
-}
-export const batchSubmitPurls = async (purls, options = DEFAULT_SCAN_INPUT_OPTIONS, batchSize = DEFAULT_SCAN_BATCH_SIZE) => {
-    try {
-        const batches = createBatches(purls, batchSize);
-        debugLogger('Processing %d batches', batches.length);
-        if (batches.length === 0) {
-            return {
-                components: new Map(),
-                message: 'No batches to process',
-                success: true,
-                warnings: [],
-                scanId: undefined,
-            };
-        }
-        const results = await processBatches(batches, options);
-        return handleBatchResults(results);
-    }
-    catch (error) {
-        debugLogger('Fatal error in batchSubmitPurls: %s', error);
-        throw new Error(`Failed to process purls: ${error instanceof Error ? error.message : String(error)}`);
-    }
-};
-export const createBatches = (items, batchSize) => {
-    const numberOfBatches = Math.ceil(items.length / batchSize);
-    return Array.from({ length: numberOfBatches }, (_, index) => {
-        const startIndex = index * batchSize;
-        const endIndex = startIndex + batchSize;
-        return items.slice(startIndex, endIndex);
-    });
-};
-export const processBatch = async ({ batch, index, totalPages, scanOptions, previousScanId, }) => {
-    const page = index + 1;
-    if (page > totalPages) {
-        throw new Error('Total pages exceeded');
-    }
-    debugLogger('Processing batch %d of %d', page, totalPages);
-    debugLogger('ScanID: %s', previousScanId);
-    const result = await submitScan(batch, {
-        ...scanOptions,
-        page,
-        totalPages,
-        scanId: previousScanId,
-    });
-    return result;
-};
-export const processBatches = async (batches, scanOptions) => {
-    const totalPages = batches.length;
-    const results = [];
-    for (const [index, batch] of batches.entries()) {
-        const previousScanId = results[index - 1]?.scanId;
-        const result = await processBatch({
-            batch,
-            index,
-            totalPages,
-            scanOptions,
-            previousScanId,
-        });
-        results.push(result);
-    }
-    return results;
-};
-export const handleBatchResults = (results) => {
-    if (results.length === 0) {
-        throw new Error('No results to process');
-    }
-    // The API returns placeholders for each batch except the last one.
-    const finalResult = results[results.length - 1];
-    return buildScanResult(finalResult);
-};
-export const buildInsightsEolScanInput = (purls, options) => {
-    const { type, page, totalPages } = options;
-    return {
-        components: purls,
-        type,
-        page,
-        totalPages,
-    };
-};

package/dist/api/queries/nes/sbom.d.ts

@@ -1,3 +0,0 @@
-export declare const M_SCAN: {
-    gql: import("graphql/language/ast.js").DocumentNode;
-};

package/dist/api/queries/nes/sbom.js

@@ -1,35 +0,0 @@
-import { gql } from '@apollo/client/core/core.cjs';
-export const M_SCAN = {
-    gql: gql `
-    mutation EolScan($input: InsightsEolScanInput!) {
-      insights {
-        scan {
-          eol(input: $input) {
-            components {
-              purl
-              info {
-                isEol
-                isUnsafe
-                eolAt
-                daysEol
-                status
-                vulnCount
-              }
-            }
-            diagnostics
-            message
-            scanId
-            success
-            warnings {
-              purl
-              type
-              message
-              error
-              diagnostics
-            }
-          }
-        }
-      }
-    }
-  `,
-};

package/dist/api/queries/nes/telemetry.d.ts

@@ -1,2 +0,0 @@
-export declare const TELEMETRY_INITIALIZE_MUTATION: import("graphql/language/ast.js").DocumentNode;
-export declare const TELEMETRY_REPORT_MUTATION: import("graphql/language/ast.js").DocumentNode;

package/dist/api/queries/nes/telemetry.js

@@ -1,24 +0,0 @@
-import { gql } from '@apollo/client/core/core.cjs';
-export const TELEMETRY_INITIALIZE_MUTATION = gql `
-  mutation Telemetry($clientName: String!) {
-    telemetry {
-      initialize(input: { context: { client: { id: $clientName } } }) {
-        success
-        oid
-        message
-      }
-    }
-  }
-`;
-export const TELEMETRY_REPORT_MUTATION = gql `
-  mutation Report($key: String!, $report: JSON!, $metadata: JSON) {
-    telemetry {
-      report(input: { key: $key, report: $report, metadata: $metadata }) {
-        txId
-        success
-        message
-        diagnostics
-      }
-    }
-  }
-`;

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

@@ -1,30 +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;
-    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,53 +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;
-    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;
-}