sonarqube-issues-exporter/dist/types/config.d.ts

Enterprise-level SonarQube issues exporter with TypeScript support for generating comprehensive HTML reports with dark theme

/**
 * @fileoverview Configuration type definitions for the SonarQube Issues Exporter
 *
 * This module contains all TypeScript interfaces and types related to application
 * configuration, including validation schemas and configuration options.
 *
 * @author SonarQube Issues Exporter Team
 * @version 2.0.0
 */
import { z } from 'zod';
import { LogLevel } from './utils';
/**
 * Zod validation schema for the application configuration
 *
 * @const ConfigSchema
 * @description Validates the complete application configuration structure
 */
export declare const ConfigSchema: z.ZodObject<{
    sonarqube: z.ZodObject<{
        url: z.ZodString;
        token: z.ZodString;
        projectKey: z.ZodString;
        organization: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        url: string;
        token: string;
        projectKey: string;
        organization?: string | undefined;
    }, {
        url: string;
        token: string;
        projectKey: string;
        organization?: string | undefined;
    }>;
    export: z.ZodObject<{
        outputPath: z.ZodDefault<z.ZodString>;
        filename: z.ZodDefault<z.ZodString>;
        excludeStatuses: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
        includeResolvedIssues: z.ZodDefault<z.ZodBoolean>;
        maxIssues: z.ZodDefault<z.ZodNumber>;
        template: z.ZodDefault<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        outputPath: string;
        filename: string;
        excludeStatuses: string[];
        includeResolvedIssues: boolean;
        maxIssues: number;
        template: string;
    }, {
        outputPath?: string | undefined;
        filename?: string | undefined;
        excludeStatuses?: string[] | undefined;
        includeResolvedIssues?: boolean | undefined;
        maxIssues?: number | undefined;
        template?: string | undefined;
    }>;
    logging: z.ZodDefault<z.ZodObject<{
        level: z.ZodDefault<z.ZodEnum<["error", "warn", "info", "debug"]>>;
        file: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        level: "error" | "warn" | "info" | "debug";
        file?: string | undefined;
    }, {
        level?: "error" | "warn" | "info" | "debug" | undefined;
        file?: string | undefined;
    }>>;
}, "strip", z.ZodTypeAny, {
    sonarqube: {
        url: string;
        token: string;
        projectKey: string;
        organization?: string | undefined;
    };
    export: {
        outputPath: string;
        filename: string;
        excludeStatuses: string[];
        includeResolvedIssues: boolean;
        maxIssues: number;
        template: string;
    };
    logging: {
        level: "error" | "warn" | "info" | "debug";
        file?: string | undefined;
    };
}, {
    sonarqube: {
        url: string;
        token: string;
        projectKey: string;
        organization?: string | undefined;
    };
    export: {
        outputPath?: string | undefined;
        filename?: string | undefined;
        excludeStatuses?: string[] | undefined;
        includeResolvedIssues?: boolean | undefined;
        maxIssues?: number | undefined;
        template?: string | undefined;
    };
    logging?: {
        level?: "error" | "warn" | "info" | "debug" | undefined;
        file?: string | undefined;
    } | undefined;
}>;
/**
 * Main application configuration interface
 *
 * @interface AppConfig
 * @description Complete configuration structure for the application
 */
export interface AppConfig {
    /** SonarQube server connection configuration */
    sonarqube: SonarQubeConfig;
    /** Export operation configuration */
    export: ExportConfig;
    /** Logging system configuration */
    logging: LoggingConfig;
}
/**
 * SonarQube connection configuration
 *
 * @interface SonarQubeConfig
 * @description Configuration for connecting to SonarQube server
 */
export interface SonarQubeConfig {
    /** SonarQube server URL */
    url: string;
    /** Authentication token for SonarQube API */
    token: string;
    /** Project key to analyze */
    projectKey: string;
    /** Organization key (required for SonarCloud) */
    organization?: string;
}
/**
 * Export operation configuration
 *
 * @interface ExportConfig
 * @description Configuration for export operations
 */
export interface ExportConfig {
    /** Output directory path for generated reports */
    outputPath: string;
    /** Output filename for the generated report */
    filename: string;
    /** Array of issue statuses to exclude from export */
    excludeStatuses: string[];
    /** Whether to include resolved issues in the export */
    includeResolvedIssues: boolean;
    /** Maximum number of issues to fetch and export */
    maxIssues: number;
    /** Template name to use for report generation */
    template: string;
}
/**
 * Logging system configuration
 *
 * @interface LoggingConfig
 * @description Configuration for the logging system
 */
export interface LoggingConfig {
    /** Minimum log level to output */
    level: LogLevel | 'error' | 'warn' | 'info' | 'debug';
    /** Optional log file path */
    file?: string;
}
/**
 * Configuration loading options
 *
 * @interface ConfigLoadOptions
 * @description Options for loading and parsing configuration
 */
export interface ConfigLoadOptions {
    /** Path to configuration file */
    configPath?: string | undefined;
    /** Configuration overrides to apply */
    overrides?: Partial<AppConfig>;
    /** Whether to validate configuration strictly */
    strict?: boolean;
    /** Whether to merge with environment variables */
    mergeEnv?: boolean;
}
/**
 * Configuration validation result
 *
 * @interface ConfigValidationResult
 * @description Result of configuration validation
 */
export interface ConfigValidationResult {
    /** Whether configuration is valid */
    isValid: boolean;
    /** Validated configuration (if valid) */
    config?: AppConfig;
    /** Validation errors */
    errors: ConfigValidationError[];
    /** Validation warnings */
    warnings: ConfigValidationWarning[];
}
/**
 * Configuration validation error
 *
 * @interface ConfigValidationError
 * @description Represents a configuration validation error
 */
export interface ConfigValidationError {
    /** Configuration path that failed validation */
    path: string;
    /** Error message */
    message: string;
    /** Expected value or format */
    expected?: string;
    /** Actual value that failed validation */
    actual?: any;
}
/**
 * Configuration validation warning
 *
 * @interface ConfigValidationWarning
 * @description Represents a configuration validation warning
 */
export interface ConfigValidationWarning {
    /** Configuration path that triggered warning */
    path: string;
    /** Warning message */
    message: string;
    /** Suggested value or action */
    suggestion?: string;
}
/**
 * Environment variable mapping
 *
 * @interface EnvironmentVariables
 * @description Maps environment variables to configuration paths
 */
export interface EnvironmentVariables {
    /** SonarQube server URL */
    SONARQUBE_URL?: string;
    /** SonarQube authentication token */
    SONARQUBE_TOKEN?: string;
    /** SonarQube project key */
    SONARQUBE_PROJECT_KEY?: string;
    /** SonarQube organization key */
    SONARQUBE_ORGANIZATION?: string;
    /** Export output path */
    EXPORT_OUTPUT_PATH?: string;
    /** Export filename */
    EXPORT_FILENAME?: string;
    /** Logging level */
    LOG_LEVEL?: string;
    /** Log file path */
    LOG_FILE?: string;
}
/**
 * Type alias for the inferred configuration type from Zod schema
 *
 * @type Config
 * @description Type inferred from the ConfigSchema for type safety
 */
export type Config = z.infer<typeof ConfigSchema>;
/**
 * Export options interface (legacy - kept for backward compatibility)
 *
 * @interface ExportOptions
 * @deprecated Use ExportConfig instead
 * @description Legacy export options interface
 */
export interface ExportOptions {
    /** Output directory path */
    outputPath?: string;
    /** Output filename */
    filename?: string;
    /** Template name */
    template?: string;
    /** Include resolved issues */
    includeResolvedIssues?: boolean;
    /** Maximum issues to fetch */
    maxIssues?: number;
    /** Enable verbose output */
    verbose?: boolean;
}
//# sourceMappingURL=config.d.ts.map